API explorer
Getting Started

Sections

API explorer

Theme switcher

Authentication

When it comes to interacting with APIs, authentication is a critical step to ensure secure communication between your application and the API service. API authentication is performed via HTTP Bearer Auth, which involves including your API key in the HTTP request headers, following the Bearer prefix. This method verifies your identity and grants you access to the API's resources, ensuring that only authorized users can make requests.

AXSMarine uses the header Authorization to authenticate requests.

To obtain an API token, please contact your account manager.

Your API keys grant significant access, so it’s crucial to keep them safe! Avoid sharing your secret API keys in public places like GitHub, client-side code, and similar locations.

API requests without authentication will fail.

Example

Authorizationstring
1 2 3 { "Authorization": "Bearer {API_TOKEN}" }

Error Codes

401 UNAUTHORIZED

The request did not provide an "Authorization" header, the content of this header was incorrect or the token provided is incorrect.

403 FORBIDDEN

The request did provide a valid token, however this token does not have permission to access this resource.

429 TOO MANY REQUESTS

The request did provide a valid token with correct permissions, however this token exceeded its number of request per specific time.