Skip to main content

Postman Collection

Spectro Cloud provides a Postman collection for your convenience to help you interact with the Spectro Cloud API.

Prerequisites​

To interact with the API, you will need the following:

  • Postman application v10.2.2 or greater.

  • A base URL for the Palette API. The default Palette API endpoint is api.spectrocloud.com, but the base URL will be different for self-hosted Palette installation. Contact your system administrator to find your base URL.

  • An authentication credential.

Authentication​

Two forms of authentication are available to interact with the Spectro Cloud API:

  • An Authentication header with a token value.
    or
  • An API Key with an ApiKey value.

Learn more about authentication methods in Palette documentation.

Import the Postman Collection​

Right-click the following URL and select Save Link as (in Safari, select Download Linked Files As ...) to download the Postman collection to your local machine.

/apis/v1/palette-apis.json

  1. Navigate to Postman on your computer and open the Import dialog.

  2. Select the downloaded API specification file and click the Continue button.

  3. Click on the Import button.

Postman imports your collection and lists it under Import Complete.

Copy/paste the URL in the Import dialog as a link.

Find details about importing in Postman's import/export tutorial.