RUX API Postman quick start guide

Use the Vectra Platform public Postman collection to get up and running quickly with the new Vectra AI Platform API.

Our Vectra Platform Postman Collection provides a great quick start introduction to what you can do with the Vectra Platform API.

Before you begin: Please note that these instructions apply only to the Vectra SaaS platform and the v3.0+ Vectra Platform REST API. To determine if you're on the Vectra Platform (aka Respond UX deployment), your Vectra login url should end in ".portal.vectra.ai".

Follow these steps to get up and running with our public Postman collection and the Vectra Platform API:

1. Log in to your Vectra Respond UX instance and navigate to Manage > API Clients.

2. Create a new API Client.

3. Record your API Client's Client ID and Secret Key for later use.

4. Fork the Vectra Platform Postman Collection to your own public or private workspace. Forking the collection requires the use of a free Postman account. Alternatively, you can export the collection for local use if you prefer not to create a Postman account.

5. If you fork the collection, you can choose to watch the original collection and get notified whenever updates are made to the original Vectra Platform collection.

6. Once you've forked the collection to your own workspace, add your API Client's client_id and client_secret_key under the Variables section of the collection. You'll also need to set the origin variable to the URL of your Vectra SaaS portal (be sure to include the https:// prefix). Save the changes.

To create an Environment and configure the variables in there (and set the environment as you mentioned). Here’s a working one:

7. The access_token, refresh_token, expires_at, and refresh_expires_at variables above will all get set dynamically as part of the OAuth2 authorization process. All other variables can be set manually later, as needed for your API testing.

8. Now you can start testing out the new Vectra Platform API!

One final note: This collection makes use of a Pre-request script, which provides a workaround for some token refresh capabilities lacking in Postman. You should not need to make any changes to the script if testing with a recent version Postman. Most other REST API tools and OAuth2 libraries can programmatically manage access and refresh tokens for you, so porting the script logic to your specific application should not be necessary.