If you want to test OTO's API and integration in a safe environment before going live, you can create a sandbox account. This allows you to simulate API calls without affecting real data.
Step 1: Create a Sandbox Account
- Visit OTO Sandbox Portal: https://staging-api.tryoto.com
- Sign up for a new account using your credentials. You can watch this video guide to create a test account.
- Once registered, log in to your sandbox account to access API testing features.
Step 2: Get the Refresh Token
After creating your sandbox account, retrieve the refresh token as explained in this guide. This token will be required to authenticate API requests.
Step 3: Use the Staging API URL
In the sandbox environment, the API base URL differs from the production version. Instead of using:
https://api.tryoto.com
Use the staging API URL:
https://staging-api.tryoto.com
Everything else in the API integration remains the same, including endpoints and request structures.
Test Delivery Companies
You can use the deliveryOptionId values below to test the createOrder, createShipment and createReturnShipment endpoints in the sandbox:
| Delivery Option | deliveryOptionId |
|---|---|
| SMSA Express | 2828 |
| SMSA Bullet | 56468 |
| SMSA Same Day | 56469 |
| SMSA Pudo | 56470 |
| SMSA Heavy & Bulky | 56471 |
Key Notes
- Testing Environment: The sandbox is designed for testing only and does not affect live operations.
- Refresh Token Usage: Ensure you use the correct refresh token from the sandbox account, not the production one.
- API Requests: Use
staging-api.tryoto.comin all API requests to interact with the test environment.
