Getting started

Try us Out
Get API Keys

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

  1. To get started with our sandbox, sign-up to get your API keys.Sign up with Rutter
  2. 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

  1. 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.

    Start in the dashboard by selecting the Open Rutter Link Button

  2. Follow Rutter Link's on-screen instructions to add a platform to your Sandbox account.

    Follow Rutter Link's onscreen instructions

  3. 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.

    Select the run code above button

  4. 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.

    Select the run code above button

Want to use Postman?

Head to the next section, Postman Setup, to get your Postman up and running.

Postman Setup

  1. 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

  2. Select Collections, followed by Rutter API Endpoints, and Create a fork.

    Create a postman fork.

  3. Select Environments, followed by Rutter Sandbox Public, and Create a Fork.

    Click the environments icon and then 'Create a Fork'

  4. Set the Environment to Rutter Sandbox Public by selecting the drop-down in the upper-right corner.

    Ruter Sandbox Public on in top left of Postman window.

  5. In the upper-right corner next to the Environment, select the Environment Quick Look button, followed by Edit.

    Edit your environment in the Quick Look Window

  6. You'll need to fill in the client_id, secret, and access_token variables with the values found in the Rutter Dashboard. Continue to Step 7 to get the client_id and secret, then Step 8 to get the access_token.

    Edit your environment in the Quick Look Window

  7. Head back to the Rutter Dashboard and navigate to the Dashboard:

    • Copy the client_id (Rutter) and paste it into the client_id field (Postman).
    • Copy the client_secret (Rutter) and paste it into the secret field (Postman).

  8. 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).

  9. 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.

  10. 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)
Next
Rutter Dashboard