What is Rutter Sandbox?
The Rutter Sandbox is an environment that enables developers to test APIs without the need to authenticate merchants via Rutter Link. The sandbox contains realistic anonymized data so that you can build your models with a certain level of confidence, confirm our data model works for your business, and verify your integration is functioning properly.
Sign-up for a Rutter Account
- To get started with our sandbox, sign-up to get your API keys.
- Continue to End-to-End Flow to understand your customer's integration experience and the data you'll get from Rutter.
End-to-End Flow
Once you sign-up, log into the Rutter Dashboard and navigate to our Getting Started page and click on Open Rutter Link to simulate your customers connecting their platforms to your platform. To learn more about Rutter Link, head over to our Overview.
Follow Rutter Link's on-screen instructions to add a platform to your Sandbox account.
Now that you have a Sandbox platform connected, make an API call by clicking Run Code Above to see the data Rutter pulls from your client's business.
That's it, you're done! You've now completed our quick walkthrough of your clients connecting to your product and getting their data from Rutter. Want to see the other data models? Use the drop-down to select a different Rutter endpoint.
Want to use Postman?
Head to the next section, Postman Setup, to get your Postman up and running.
Postman Setup
If you'd like to test using Postman, we've done most of the heavy lifting already. Head over to our Postman collection. Run in Postman
Select Collections, followed by Rutter API Endpoints, and Create a fork.
Select Environments, followed by Rutter Sandbox Public, and Create a Fork.
Set the Environment to Rutter Sandbox Public by selecting the drop-down in the upper-right corner.
In the upper-right corner next to the Environment, select the Environment Quick Look button, followed by Edit.
You'll need to fill in the
client_id
,secret
, andaccess_token
variables with the values found in the Rutter Dashboard. Continue to Step 7 to get theclient_id
and secret, then Step 8 to get theaccess_token
.Head back to the Rutter Dashboard and navigate to the Dashboard:
- Copy the
client_id
(Rutter) and paste it into theclient_id
field (Postman). - Copy the
client_secret
(Rutter) and paste it into thesecret
field (Postman).
- Copy the
On the Rutter Dashboard and navigate to the Connections menu option. Copy the ACCESS TOKEN (Rutter) and paste it into the
access_token
field (Postman).We have all the environment variables we need, go ahead and Save your changes.
Note
Make sure the INITIAL VALUE and the CURRENT VALUE are filled in. They will be the same value.
You're all set! SEND IT
Supported Endpoints
Sandbox API Calls
Don't forget to change your base URL from https://production.rutterapi.com/versioned to https://sandbox.rutterapi.com/versioned to make API calls from our Sandbox environment.
We support the following endpoints in sandbox mode:
- Fetch All Orders (GET /orders)
- Fetch an Order (GET /orders/{id})
- Fetch All Products (GET /products)
- Fetch a Product (GET /products/{id})
- Fetch All Customers (GET /customers)
- Fetch a Customer (GET /customers/{id})
- Fetch All Transactions (GET /transactions)
- Fetch All Payouts (GET /payouts)
- Fetch a Store (GET /store)