Meevo DDS Workflow Overview
This is a general overview of how to set up and use the Daily Data Stream:
1. Gather your credentials from the Welcome Kit
The "Welcome Kit" we emailed you contains all of the information needed to get started using the DDS. In that email is:
- Your private key file (.ppk): Use this private key file to access the SFTP. In the SFTP, each location has its own unique folder; the folders that you can access depend on the permissions granted to your private key file .
- The SFTP details: We provide you with the sftp user, sftp host, Key passphrase, and sftp home directory. You'll find these details in the Partner Info tab of the Welcome Excel file.
- Your AppId and AppSecret: You'll use these keys, which are unique to your account, to authenticate most of your calls. You'll find these keys in the Partner Info tab of the Welcome Excel file.
- Your Meevo User Name and Password/PPK Passphrase: Log into the Meevo front-end using the Meevo User Name and Password, and you will use the same password as the PPK Passphrase. You'll find this information in the Other Info tab of your Welcome Excel.
2. Obtain the Starter Export files
Once a location is activated for DDS, the location's data is provided to you in the form of Starter Export files, which we provide via SFTP. These files contain a location's data, in the form of delimiter-separated values, for your selected entities. They are the starting point in your system for a location's data.
Note for multi-locations: You are billed according to your number of active locations. To avoid being billed for churn (locations who you are no longer doing business with), it is important that you deactivate defunct locations as described here.
3. Use your AppId and AppSecret to obtain a JWT (bearer token)
To authenticate your calls, you'll need to include a JSON Web Token (JWT) in the header of most requests. The JWT is unique to your app and determines your permissions while using our Public APIs.
4. Request deltas for the desired entities
Request deltas from a DDS location through the endpoints described here, making sure to include the JWT.
Supplemental Endpoints Included with DDS
"GUID lookup" endpoints
Records returned by the DDS may include GUIDs for data items such as services and products. You can cross-reference those GUIDs using our Public API GET endpoints to obtain complete records for those items (services, products, memberships, etc.).
Note: Only GET Public API endpoints are included with the DDS. To write data to Meevo, sign up for Meevo Public APIs via this form.
"Locations you have access to" endpoint
The "Get info on accessible tenants and locations" endpoint provides you with important information regarding tenants and locations that you have entitlements to. You'll need this information in order to make any DDS or API request.
Location endpoints for our Trusted Partners
Our Trusted Partners are able to use the following endpoints for managing locations:
Get a tenant's location IDs
A location ID is required to activate a location and to request deltas from a location. The "Get location IDs" endpoint reveals all location IDs for a particular tenant.
Activate a location
When called successfully, the "Activate a location" endpoint does the following:
- Queues up the Starter Export files to be generated
- Enables the location to generate deltas using the Daily Data Stream
- Creates an API user, if necessary
Note for multi-locations: You are billed according to your number of active locations. To avoid being billed for churn (locations who you are no longer doing business with), it is important that you deactivate defunct locations as described here.