Authentication

Abyssale uses API Key Authentication: Your API key is passed along with every API call, allowing Abyssale to identify your company account and access your data.
How to get an API Key?
1.Go to app.abyssale.com & log in
2.Click Settings on the top bar
3.Click API Key on the left menu
4.Click the blue Request an API button.
5.Once done, your API Key become available & you can copy it (by clicking the icon copy button on the right part).
All of your Abyssale requests must contain a x-api-key header with your API Key
How to test your authentication?
Just call the GET /ready route with the header mentioned below, as follows:
cURL
Javascript
Python
curl -i -H "x-api-key: {YOUR-API-KEY}" https://api.abyssale.com/ready # HTTP/2 200
const axios = require('axios');
​
axios.get("https://api.abyssale.com/ready", {headers: {"x-api-key": "{YOUR-API-KEY}"}}).then(response => {
    console.log(response.status) // 200
})
import requests
​
r = requests.get("https://api.abyssale.com/ready", headers={"x-api-key": "{YOUR-API-KEY}"}, timeout=30)
r.status_code # 200
If the status code received is a 200, everything is OK.

Rest API - Previous

Overview - Rest API

Next - Rest API

Templates

Last modified 3mo ago

Copy link

Outline

How to get an API Key?

How to test your authentication?