Quick Start

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

All API calls require a Bearer token in the request header.

• Token validity: 1 hour
• Testing: reauthenticate when required
• Production: implement a refresh token mechanism

Step 1: Download the API Definition

Open the API catalog, select your product, and go to API Documentation. Download the OpenAPI definition in YAML or JSON from the top of the page.

View full-size image — YAML and JSON download buttons

You can test with the in-portal Try It flow or import the definition into an external API client such as Postman or Bruno. In external tools, create a persistent token variable and pass it in the Authorization header for subsequent endpoint calls. Refresh or replace the token after 1 hour.

Step 2: Authenticate

1. Open the Authenticate endpoint.
2. Click Try it.
3. Select your environment in the top-right corner.
4. Enter username and password in the request body.
5. Click Send and copy the returned bearer token.

View full-size image — Try it button

View full-size image — Authenticate endpoint response

Step 3: Send Your First Request

1. Open the endpoint you want to test.
2. Click Try it.
3. Go to Security and confirm Authorization is set to JWT.
4. Set bearerToken_token with your bearer token value.
5. If the variable does not exist, create one and reference it as {{variable_name}}.
6. Add all required endpoint parameters before sending the request.
7. The Try it console shows the available parameters for the selected endpoint. Complete any required fields to ensure a valid request.
8. Send the request.

View full-size image — Bearer token variable setup

Resources

• API errors: Error Responses