Postman Collection

Before getting started, install the latest version of Postman.

Import the collection

You can easily fork our public API collection to your Postman by clicking the button below:

Run in PostmanRun in Postman

Configure environments for Sandbox and Production

To set up your environment for quickest development, you can go to the variables tab and add your sandbox appId and appSecret to the collection.

We recommend setting up separate environments for Sandbox and Production. This will enable you to quickly switch between environments without having to manually look up and change your API keys.

To create an environment in Postman:

  1. Select New in the left navigation menu in Postman
  2. Choose Environment to create a new environment
  3. Enter Abound Sandbox for the name of your new environment
  4. Using your keys from our dashboard, enter the following environment variables for your sandbox environment:
Creating the Abound® Sandbox environment

Creating the Abound® Sandbox environment

Sandbox environment

VARIABLEINITIAL VALUECURRENT VALUE
baseUrlhttps://sandbox-api.withabound.com/<<apiVersion>>https://sandbox-api.withabound.com/<<apiVersion>>
appId{{appId}}Enter your sandbox appId
located on the keys page of the Abound Dashboard
appSecret{{appSecret}}Enter your sandbox appSecret
located on the keys page of the Abound Dashboard

Production environment

VARIABLEINITIAL VALUECURRENT VALUE
baseUrlhttps://production-api.withabound.com/<<apiVersion>>https://production-api.withabound.com/<<apiVersion>>
appId{{appId}}Enter your production appId
located on the keys page of the Abound Dashboard
appSecret{{appSecret}}Enter your production appSecret
located on the keys page of the Abound Dashboard

Using the Postman collection

Now that you have your collection and environments configured, you're ready to make our first request. Since Users are our foundational resource of every API call, first create a User.

  1. Select the Collections icon in the left navigation menu
  2. Expand Abound API, Users, and then select Create a user
  3. Ensure you are using the Abound Sandbox environment you created earlier by selecting it in the upper right-hand corner
  4. Click Send to create a user
Creating a user with the Postman collection

Creating a user with the Postman collection

Now that you've created your first user, you will need to use the returned userId to make other API calls.

  1. Note the userId from our original request to Create a user
  2. Open the Create documents request in the Postman collection and hover over the {{userId}} path variable
    • You will find that our collection populates the userId we just created
  3. Without additional input, click the Send button to create a document for this user
Example of userId being automatically provided for the next request

Example of userId being automatically provided for the next request

📘

When creating multiple resources in a request, Postman only saves the identifier for the first resource as a collection variable.