​
Prerequisites

​
Setup

Import the Orb collection into Postman. You can download the Postman application. Orb recommends forking the collection so you can safely add your API key: Run in Postman

​
Postman environment setup

A full list of available Orb API calls is structured by resource in the left sidebar. In the left sidebar, you can click on the menu button to view the documentation for the given folder or specific API request.

​
Authentication

Before you generate an API Key, you’ll want to enable test mode in the top left of the Orb UI. Test mode gives you a safe playground that doesn’t affect your production customers or data.
This collection includes a Postman “Environment” called “Test Mode”. In the Orb UI, you’ll want to head over to the API Keys tab in the settings page here to generate an API Key. Once you have that:
  1. Navigate to the environment by clicking the “Environments” tab on the left side, and clicking the “Test Mode” environment.
  2. Fill in the api_key with your API key
    • Variables allow you to share values within the collection.
    • To learn more about Postman variables, see the documentation.

​
Working with the collection

After setup is complete, you are ready to begin making API calls. In the Orb API Reference folder, there are subfolders for each type of API resource listed in the Orb API Reference. Expand the subfolders to see the HTTP methods and API call names.