Using the internal API

Sometimes there are actions that are possible through the UI, that aren't available in the platform API. Or sometimes the behaviour of a platform endpoint might not do everything that you'd expect from a similar action in the UI.

The internal API (the API used by the UI) is available for all developers to use, offering a more extensive feature list. However, there is NO documentation to assist along the way. But it's very possible to start working with the internal API using these steps.

Understanding the difference between the Platform API and the Internal API

All platform API calls use the following url: https://platform.roserocket.com/...

Internal API calls use your organizations subdomain: https://<subdomain>.roserocket.com/....

The same authorization workflow is valid for the internal API as the Platform API. The same token will work for both.

Finding Internal API endpoints for UI actions

In order to find the internal API endpoints for different UI actions, follow these steps.

1. Sign in to Rose Rocket in the UI, and navigate to your desired action but do not initiate the action
2. Open up the Developer Tools in the browser (Right click >> "Inspect")
3. Click on the Network Tab and clear out any existing requests
4. Perform the action in the UI
5. Read through the various Network requests that were made as part of the action, and look for one that sent a request to the internal API. They will usually be well named (something like "invoices" or "partner_carriers"). In some cases, the relevant call will just be the UUID of the associated object.
6. Once you've found the Network request corresponding to the desired action, read through the Payload and Response to understand the necessary inputs (Payload) and outputs (Response)

While we continue to improve our platform API, using the internal API will often be a quicker approach if a desired endpoint can't be found.

Finding Internal API GET endpoints

If you are simply looking to retrieve information from the internal API, follow these steps:

1. Sign in to Rose Rocket in the UI, and navigate to a page showing the information you're looking to retrieve
2. Open up the Developer Tools in the browser (Right click >> "Inspect")
3. Click on the Network Tab and clear out any existing requests
4. Refresh the page
5. Read through the various Network requests and look for one that sent a request to the internal API. They will usually be well named (something like "invoices" or "partner_carriers") or will just be the UUID of the associated object.
6. Once you've found the Network request corresponding to the desired GET endpoint, read through the Payload and Response to understand the necessary inputs (Payload) and outputs (Response)