Make Authenticated API Calls

Configure authentication to securely access deployment content. Test your setup by making an API call using either a Simple API Key or a JWT, based on your previous configuration.

Obtain your organizationId from your Customer Success Manager (CSM) and your deploymentIdentifier from the Deployments interface. See Obtain Parameter Values for Endpoint URLs.
Create either a Simple API Key or JWT HS256 Key in Heretto CCMS. See Create an API Key.
If using JWT, create your JWT. See Create a JWT.

Replace endpoint URL variables with actual values

In the endpoint URL, replace the organizationId and deploymentIdentifier variables with the values you obtained.
Search endpoint URL before variables are replaced:
```
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/search
```
Search endpoint URL after variables are replaced:
```
https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search
```

Apply the authentication method

Apply the authentication method of your choice in your API requests:

Option Description

Option	Description
Simple API Key	Apply the key as generated in Heretto CCMS directly in your API requests using either the header or URL parameter method. Header Authentication `curl --location 'https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/structure' \ --header 'X-Deploy-API-Auth: a59ac183a8bc4a848c92082f91b863dc'` URL Parameter Authentication `https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/structure?token=a59ac183a8bc4a848c92082f91b863dc`
JWT	Warning: Use the JWT signed with a JWT HS256 key, NOT the original JWT HS256 key you generated in Heretto CCMS. The JWT must be signed with a JWT HS256 key first. Apply the signed JWT in your API requests using either the header or URL parameter method. Header Authentication `curl --location 'https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search' \ --header 'X-Deploy-API-Auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWRpZW5jZSI6ImF1ZGllbmNlX2EifQ.x7KlW9Z5jS6ImF1ZGllbmNlX2Ei'` URL Parameter Authentication `https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWRpZW5jZSI6ImF1ZGllbmNlX2EifQ.x7KlW9Z5jS6ImF1ZGllbmNlX2Ei`

Simple API Key

Apply the key as generated in Heretto CCMS directly in your API requests using either the header or URL parameter method.

Header Authentication

curl --location 'https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/structure' \
--header 'X-Deploy-API-Auth: a59ac183a8bc4a848c92082f91b863dc'

URL Parameter Authentication

https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/structure?token=a59ac183a8bc4a848c92082f91b863dc

JWT

Warning:

Use the JWT signed with a JWT HS256 key, NOT the original JWT HS256 key you generated in Heretto CCMS. The JWT must be signed with a JWT HS256 key first.

Apply the signed JWT in your API requests using either the header or URL parameter method.

Header Authentication

curl --location 'https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search' \
--header 'X-Deploy-API-Auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWRpZW5jZSI6ImF1ZGllbmNlX2EifQ.x7KlW9Z5jS6ImF1ZGllbmNlX2Ei'

URL Parameter Authentication

https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWRpZW5jZSI6ImF1ZGllbmNlX2EifQ.x7KlW9Z5jS6ImF1ZGllbmNlX2Ei

A successfully authenticated request returns a 200 status code with the requested content. An example of a successful response is:

{
    "status": "success",
    "data": {...}
  }

Common issues:

401 Error: Verify that your API key or JWT is correct and not expired
404 Error: Check that your organizationId and deploymentIdentifier are correct
Empty Response: Ensure you're using the correct endpoint for your deployment type

Under maintenance

Heretto Help

Make Authenticated API Calls

Footer Section

Our Support Team is here to help