API Quickstart Apps

The API Quickstart apps provide sample code for obtaining an access token and making a simple query to the API. You can use the apps for reference, or modify them to test out your own API requests in a development environment.

Prerequisites

For any of the quickstart apps, you will need three things:

• Your MyDataHelps service account name, like “MyDataHelps.1234.test.” See Service Accounts.
• Your MyDataHelps project ID. See API Basics.
• The private key you associated with your service account.

Quickstart Apps

Quickstart apps are available in the following languages:

• Node.JS
• Python
• Java

Postman Collection

Postman is a great tool for testing REST APIs. The MyDataHelps Postman Collection contains a number of sample queries to help you get up and running quickly.

To use the collection:

1. Create an account in Postman and log in. You may also use the desktop client.
2. Navigate to the CareEvolution MyDataHelps Workspace. In the desktop client, use the search bar to find the CareEvolution collections.
3. Select the collection and create a fork. This is your own private version of the collection.

4. Enter your project ID, service account name, and service account private key in the “variables” section. In the private key, be sure to include the begin/end key tags (e.g., -----BEGIN RSA PRIVATE KEY-----) and linebreaks.

5. Select a query from the collection.
6. Adjust the parameters and body data as needed. Be sure to check the box next to any query parameter you want to use.
7. Click “Send.”

See the Postman Docs for more details about working with forked versions, including how to update your fork when the parent changes.

Using Other Tools

If Postman is not right for you, there are numerous other REST API testing tools. However, most of these tools do not readily support the private key authentication needed by the API. To get around this, you can use one of the quickstart apps to obtain a temporary access token. It will only be good for a few minutes, and you will need to manually include it in your content headers.