Overview
The Search Atlas REST API requires proper authentication before making API calls. Understanding how to obtain and use the correct credentials is essential to successfully integrating with the API. This article covers how to authenticate with the Search Atlas API and how to resolve common API errors related to credential configuration.
Part 1 — Authenticating with the Search Atlas REST API
The Search Atlas REST API uses a token-based authentication system. To make authenticated API requests, you must first obtain an access token using your Search Atlas account credentials.
What credentials are required?
- username — your Search Atlas account email address (the same one you use to log in to app.searchatlas.com)
- password — your Search Atlas account password
These are the same credentials you use to log in to the main platform. Once you have obtained your access token, include it in the headers of subsequent API requests as a Bearer token.
Important notes:
- Access tokens are time-limited. If you receive an authentication error mid-session, re-request a fresh token and retry your request.
- Make sure you are using your Search Atlas login credentials, not a separate API key, when requesting an access token from the token endpoint.
- Avoid hardcoding credentials directly in shared scripts. Use a secure credential storage method appropriate for your integration environment.
Part 2 — Fixing Common API Authentication Errors
If you are receiving authentication or configuration errors when calling the Search Atlas API, the most common causes are:
- Wrong credential type — Using the wrong value (for example, passing a login password where an API key is expected, or vice versa). Confirm which credential type each endpoint requires before making calls.
- Incorrect or malformed credential — The credential was copied with extra whitespace, a missing character, or from an outdated or revoked source. Copy your credentials carefully from your Search Atlas account settings.
- Credential not yet generated — If you have not yet created an API key or token in your account, the relevant endpoint will reject your request. Check your account settings to confirm your credentials exist and are active.
- Incorrect endpoint URL — Requests sent to a wrong or mistyped endpoint path will return errors. Double-check the endpoint URLs against the official Search Atlas API documentation.
If you are unsure which credentials or endpoint configuration apply to your specific use case, gather the following before escalating: the endpoint URL you are calling, the exact error message or response code you are receiving, and the credential type you are passing.
If you need further assistance, open the chat widget in the bottom-right corner of the platform and type human teammate to be connected with a member of our team.