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:
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:
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.
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.
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.
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
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:
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.
Please execute the following steps to execute this example using POSTMAN.