This section outlines the essential steps to get started with the API, including the required preconditions and sample requests. By the end of this guide, you’ll be equipped to successfully fetch and test transport orders from the API.
If you encounter any issues with this guide or would like to share your feedback, please don’t hesitate to reach out to us at support@rio.cloud. We’re here to help!
Before you start the onboarding process for the Order Exchange API, ensure you have completed the following steps:
At RIO, integrating services with the Order Exchange API requires a Partner Integration Client. This client is built on the OAuth 2.0 protocol and is used to authenticate your application with the RIO Identity and Access Management (IAM) API.
What sets the Partner Integration Client apart is its ability to use a single set of client credentials across multiple accounts. The only detail you need to modify is the partner integration ID. With this approach, switching between production and test accounts is simple—just update the integration ID, and you're good to go.
Great news! Partner integration clients are created by RIO. All you need to do is provide us with some essential information so we can set up the client for you.
Once you’ve gathered all the necessary information, please send an email to our support team with the details listed above or use the RIO contact form.
Hello RIO Support Team,
We would like to integrate our application with the Order Exchange API. Could you please create a partner integration client for us?
Thank you in advance.
Best regards,
[Your Name/Team]
You can expect to receive the partner integration client within 2-3 business days. For now, you’re all set. You will receive two separate emails with instructions on how to download the client ID and client secret.
In addition to the client ID and client secret, you’ll also need the integration ID. This ID serves as the link to your RIO account. When you specify your account ID in the request above, this connection is established automatically.
If you need access to a test account, please reach out to your shipper. Upon request, we can link your client to one of our test accounts. You will receive an additional integration ID for the test account, which will be sent via email to the designated technical contact.
You now have your client_id, client_secret, and integration_id. These credentials are essential for requesting an access token from the RIO IAM API. The access token will authenticate your application with the Order Exchange API.
Parameters:
grant_type=partner_integrationintegration_id provided to the partner during product activationThe access token is valid for 60 minutes.
If the request fails, this could have several reasons. The most common ones are:
Authorization headerOnce you have a valid access token, you’re ready to test the Transport Order Exchange and fetch your first transport orders.
Parameters:
Bearer authentication with the access token from previous request.If the request fails, this could have several reasons. The most common ones are: