Skip to main content

Getting Started

Welcome to the Archlet API – let’s get you up and running in under 5 minutes.

Accessing Archlet APIs is a simple two-step process:

  1. Authenticate with our Authorization Server to get an access token (using the OIDC Client Credentials Flow)
  2. Use the access token to make secure API requests

What You’ll Need​

To get started, you’ll need a Client ID and Client Secret for a Service Principal. Please contact your Archlet Customer Success Manager to obtain your credentials.

Step 1: Retrieve an Access Token​

Archlet APIs are protected endpoints, so the first step is to authenticate and retrieve an access token.

Send a POST request to our authorization server with the following details:

Request URL

https://login.archlet.io/oauth/token

Headers

Content-Type: application/json

Body

{
  "client_id": "<your-client-id>",
  "client_secret": "<your-client-secret>",
  "audience": "https://app.archlet.io/customer-api/",
  "grant_type": "client_credentials"
}

You’ll receive a response like this:

{
  "access_token": "eyJ...",
  "expires_in": 600,
  "token_type": "Bearer"
}

The access_token is what you’ll use to authenticate your requests to the Archlet APIs.

How to Use the Access Token​

Pass the token in the Authorization header of your requests:

Authorization: Bearer <access-token>

Token Expiry​

Access tokens are valid for 10 minutes.

If you send a request with an expired token, the API will respond with:

401 Unauthorized

To continue, just request a new token using the same process.

warning

Avoid fetching a new access token for every API call.

Access token generation is rate-limited, and overusing it can result in:

429 Too Many Requests

We strongly recommend caching the token and reusing it until it expires.

Step 2: Make Your First API Call​

With a valid access token in hand, you're ready to start using the Archlet APIs.

Check out our API reference for available endpoints, data models, and request examples.