MyDataHelps REST API Java Quickstart

This app is a demonstration of how to access the MyDataHelps REST API using Java. It gives an example of obtaining an access token and making a simple query to the API. You can use this app for reference, or modify it to test out your own API requests in a development environment.

Prerequisites

Before you begin, you will need three things from MyDataHelps Designer:

• Your service account name, like RKStudio.12345678.Test.
• Your project ID, which is a GUID.
• The private key you associated with your service account.

For help finding this information, see the MyDataHelps Developer Docs.

Using the App

This is a command-line application in Java. To run the app:

1. Clone this repository.
2. Copy the src/main/java/Config.dist file and name it src/main/java/Config.java.
3. Edit the new src/main/java/Config.java file. Fill in your project ID, service account name, and private key. See Prerequisites above for how to get this information. Be sure to include the begin/end tags “--BEGIN RSA PRIVATE KEY--“ and “--END RSA PRIVATE KEY--" in your private key, and use line breaks. It should look something like this:

PRIVATE_KEY = "-----BEGIN RSA PRIVATE KEY-----\n230703de230703de230703de\nb62b0e24b62b0e24b62b0e24\n...\n-----END RSA PRIVATE KEY-----"

NOTE: If you choose to fork this repository, make sure you do not commit your credentials to source control.

4. The quickstart app is set up with a gradle dependency wrapper, so you can just use ./gradlew run to run it from the command line. Alternately, you can build the app and its dependencies in your preferred IDE, and then run the Quickstart class.

If successful, the app will print out a service access token and number of participants in the console, like so:

--------------------------
Obtained service access token:
  YOUR TOKEN HERE
--------------------------
Total Participants: 5
--------------------------

The service access token is only valid for a few minutes, but you can copy/paste it into a REST query tool of your choice to try out advanced queries.

If you examine the Quickstart.java file, you will see additional sample code for other tasks, such as creating/retrieving a participant, and generating a participant access token.

Troubleshooting

If you see an error when running the application, double-check the information in the Prerequisites, particularly the format of the private key.

If you have trouble getting the application to work, feel free to contact MyDataHelps Support.