doctype html> Rose Rocket Platform API - Getting Started NAV Navbar

Rose Rocket Platform API - Getting Started

The purpose of this page is to provide a guided tutorial in executing a simple, sample task in the hopes that the pattern established here will provide further insight to integration developers. This task will just be to list all customers within your organization. While ultimately very simple, it should serve as a foundational basis to perform even the more complicated API calls.

N.B. These examples will not work as is, they are meant to be updated with your organization's particular configuration.

Base Request URLs:

Postman

Download

For the purposes of providing visual cues, we'll be using the POSTMAN Application to perform this guided tutorial. Exact endpoints and code samples are provided in the full API document, and will be linked with each sample.

You can download POSTMAN from the link below:
https://www.getpostman.com/downloads/

Setup

Once downloaded, you'll need to setup the calls that we'll be using. We've provided Postman Profiles to speed up this process.
Please download the following files:

Referring to the screenshot below, please import the aforementioned files using the 'Import' function outlined in red. On successful import, your UI should be updated with the profile required to follow this tutorial. Please note the fields outlined in green.

Authentication

In order to execute any of the actions supported by the RoseRocket API, your session must be authenticated using the 'Auth' endpoint. Access tokens last for a maximum of 24 hours, and must be included in the header with all API requests.

API ENDPOINT:
https://auth.sandbox01.roserocket.com/oauth2/token

RoseRocket Account Setup:

Some initial setup is required in your organization's environment in order for authentication to proceed. Your integration needs to be registered as an official 'App', or the API will refuse connections outright. Please execute the following steps; reference points can be found in the provided screenshots.

  1. Navigate to your organization configuration screen 1 and scroll down to the section labelled 'Org Apps' 2
  2. Fill out the 'Name' 3 field with any name that will help you identify the use of this key (ex. "My Integration Application") and click on the 'plus' icon.
  3. On success, you will see immediate confirmation, much like the example key in the screenshot, outlined in green.

Postman Auth Setup:

  1. In the left navigation, please select the 'Authenticate' action 1
  2. Update the Request body by selecting the 'Body' tab in the submenu 2
  3. Update the username and passwword fields with your RoseRocket Login Credentials
  4. Update the 'client_id' with the Org App Key 3.
  5. Update the client_secret. The secret key is not visible in the UI, but will be copied to your clipboard when you click on the secret–key button 4.



Postman Auth Completion:

Once setup is complete, clicking on the 'Send' button should respond with a positive response, including an access token. As stated before, this access token will only be valid for 24 hours, and is required for all requests into the system.

Once these steps are complete, every POSTMAN request will contain the access token in their headers, opening up access to the rest of the API.

Using the included access key, you will need to update your headers, by following these few steps:

  1. After click 'Send' 1, the response body will contain a JSON object, with an attribute listed as 'access_token' 2. Copy it for step 2.
  2. Click on the 'Environment Quick Look' in the top toolbar 3 to open the submenu.
  3. Update the 'authorizationToken' 4 with the field copied from step 1.



Simple Example: List Customers

Overview:

The execution of this API call within POSTMAN will provide example feedback for what to expect, and will hopefully make clear how this is achieved when compared side-by-side with the API guide entry.

Search Customers:

Please execute the following steps to execute this example using POSTMAN.

  1. In the left nav, expand the 'Customers' section 1, and select the 'Search' action.
  2. Once you click 'Send', you should see the JSON response with a list of your customers. (Please note the limit & offset 2, to help manage results.
  3. The screenshot also show the headers that were passed with the request 3. This should coincide with the example code block 4.