Core

How to create an API Key ?

Using the NPM Core Package

The Core setup will allow you to use the core methods to access the service API.

AbyssSpotlightCore.setConfig({
      // Your Abyss Account API key
      apiKey: "spotlight-account-api-key",
});
AbyssSpotlightCore.enableAxiosRetry();

Standalone

If you are not using the NPM package to access the API, you can skip this step and just set your API key on the HTTP request header.

// HTTP Version
GET /api/user/me HTTP/1.1
Host: spotlight-api.abyss-project.fr
abyss-spotlight-api-key: "abyss-spotlight-api-key"

// Curl Version
curl --location 'https://spotlight-api.abyss-project.fr/api/user/me' \
--header 'abyss-spotlight-api-key: abyss-spotlight-api-key'

abyss-spotlight-api-key:allow you to access account endpoint