Authentication

Overview

Sky Mavis APIs use API keys to authenticate requests. You can view and manage your API keys in the Developer Console.

To authenticate a request to a Sky Mavis API, you need to populate the X-API-Key header with the key assigned to your app. If you don't have an app yet, create one.

API keys carry many privileges, so keep them safe. Don't share your API keys anywhere that's publicly accessible, like GitHub or client-side code.

All API requests must be made over HTTPS. Calls made over plain HTTP fail, as do API requests without authentication.

General use

To call the API endpoints, add the key to the X-API-Key HTTP header as follows:

curl -L -X GET 'https://api-gateway.skymavis.com/{API_NAME}/resource/operation' \
-H 'Accept: application/json' \
-H 'X-API-Key: dTreM7cRn8XMVF38l6Z8wTaZTWcKhLeC'

Use in documentation

To send requests from our API documentation pages, paste your API key in the ApiKeyAuth field, and then click SEND API REQUEST.

Until you navigate away from the documentation, your API key remains set and automatically included in every request that you make.