DDS Developer Portal: Getting Started

The Meevo Daily Data Stream (DDS) helps you keep track of changes to Meevo Appointment, Sale, Client, Employee, and Employee Schedule records within a location. Any record that gets added, edited, or deleted within the past 7 days are captured by the DDS service and returned in JSON format when called. 

The DDS is a one-way stream of data from Meevo to the caller. This solution does not offer the ability to change data within Meevo; it is a service that provides data streams for consumption by a third-party application. The Daily Data Stream:

  • Provides data at the location level; the DDS cannot be used with Central Office
  • Uses REST APIs
  • Uses standard HTTP authentication and verbs
  • Returns all responses in JSON

Supported Entities

You can request deltas for the following supported Meevo entities:

  • Clients
  • Employees
  • Employee Schedules
  • Appointments
  • Sales

How the Daily Data Stream Works

  1. When you first sign up to use the DDS, MSI provides you with a collection of Starter Export files via SFTP. These files are specific to each location that will be using DDS.
  2. Starter Export data is meant to be ingested/synced into your app or system to create a "starting point".
  3. From then on, you'll be able to keep all of that data up-to-date and synced with Meevo by simply calling the DDS "deltas" endpoints and replacing your records accordingly.

See the DDS Workflow Overview for more specific information.

Meevo Data in Multi-Locations

The DDS provides location-level data. Calls are made directly to locations, never to Central Office (CO). When it comes to location-level data, it's important to understand the data management structure in Meevo:

  • Most data in Meevo can be created and managed by either CO or a location.
  • Data that is CO-managed will be visible within Meevo for each location that has been granted rights to that data by CO.
  • Data that is managed by a location will not be visible to any other locations.
  • It is therefore likely you will see unique data sets between locations. If a particular data item is available at several locations, its GUID will be the same across all of those locations.

The Starter Export Files

"Starting point data" is provided to you via SFTP in the form of Starter Export files. There will be several files for each entity. In terms of historical data, the DDS provides:

  • For the Appointment Entity: All past and future appointments
  • For the Sale Entity: All sales and transactional data
  • For Client and Employee Entities: All profiles regardless of status (active, inactive, deleted)
  • For the Employee Schedules/Actuals Entities: All past and future schedule and actual data

The Meevo DDS Test Bed

When you first sign up for our Public API or DDS solutions, we'll provide you with access to a test bed where you can become familiar with our endpoints. The test bed is a working Meevo environment that comes with staged data. If you are developing an app, you can develop and test the app against this environment and its data.

To simulate the types of Meevo data changes that might occur within a business, you can log into the front-end of this Meevo environment and manipulate the data however you'd like.

Please note:

  • To stage changes in Meevo, you will likely need to log into the test bed front-end to make changes to data manually. For example, you can make a sale in the Meevo register and then call the DDS Sale endpoint to see that sale record returned, or create a client profile to see that profile returned by the DDS Client endpoint.
  • This environment is shared with other integrators. It is not meant for you to enter real data that may contain personally identifiable information.
  • Your Test Bed credentials will expire after 90 days if your app is not live in Production by then. Once your app is live in Production, you will be granted continued access to the Test Bed to allow for additional testing going forward.

Test Bed URL

https://d18devpub.meevodev.com

Marketplace Test Bed URL

https://d18devmarketplace.meevodev.com