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

Before you begin, you will need three things:

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

Quickstart Apps

Quickstart apps are available in the following languages:

RKStudio Postman Collection

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

To use the collection:

  1. Install Postman.
  2. Import the collection into Postman. Postman has a number of ways to do this. You could fork the collection, or download and then import the collection into the Postman app. Consult the Postman documentation for details.
  3. Set up the project variables as described in the “Documentation” tab of the collection.
  4. Select a query from the collection.
  5. Adjust the parameters and body data as needed.
  6. Click “Send.”

Once you configure your project variables, the collection handles the authentication and content headers for you.

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.