How do I obtain an access token for the ReadyCloud API?

The ReadyCloud API provides read and write access to orders, boxes, items, addresses, and all the other major data stored and processed by ReadyCloud. It is a modern JSON-based RESTful API.

Version 2.0 of the API is a major upgrade that provides many new properties and features, while at the same time simplifying and improving the format. Field naming is better, fewer fields are ‘custom fields’ but instead fully formatted and documented properties and we have a new way to distinguish explicit and implicit data.

1. Create Your API Key

  1. First, be sure you are logged in to your ReadyCloud account and your user has "Administrator" privileges.

  2. You will first need to create a new "App". To do so, visit the following URL: https://www.readycloud.com/settings/clients/
    1. In the App Name textbox, choose a name for your App.
    2. Click the +Add App button.


  3. You will now see your new App listed. Select the value in the "App Id" field then copy and paste it into a text editor.




  4. You will now create your authorization URL. Copy the URL below into the text editor and replace {app_id} with the value you saved from Step 3.

    https://www.readycloud.com/api/v1/oauth2/authorize?response_type=token&client_id={app_id}

  5. Copy the URL created in Step 4 and paste it into a web browser. Click the Allow Access button to create the permissions for your API key:


  6. On the next page, you will see the {bearer_token} that you will need to make calls to the ReadyCloud API. Save this token somewhere safe as you will not be able to access it again after leaving this page.


2. Retrieve Your Org ID

Next, you will need to make a request to the API to retrieve the Org ID for your ReadyCloud account:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/?bearer_token={bearer_token}"
You will receive a response that looks similar to the below:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "/api/v2/orgs/BX6/",
            "name": "ACME Corp.",
    ...

In the {url} field, the last 3 digits before the trailing slash are your Org ID. In the example above, the Org ID is: BX6

The Org ID must be included in your endpoint URL when making API requests.

3. Your Endpoint URL

Below is an example of your final endpoint URL:

https://www.readycloud.com/api/v2/orgs/{org_id}/orders/?bearer_token={bearer_token}

You can now begin making requests to the ReadyCloud API. Please continue with the API documentation here:

https://www.readycloud.com/static/api-doc/v2/02-apireference-v2-02-orders.html

Still need help? Contact Us Contact Us