Authentication
Authentication - Abyssale REST API
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.
Access to the API key requires at least an Admin role.
- 1.
- 2.Click
Settingson the top bar - 3.Click
API Keyon the left menu - 4.Click the blue
Request an APIbutton. - 5.Once done, your API key will be available (with a small delay of 30seconds) & you can copy it (by clicking on the copy icon button on the right part).
All of your Abyssale requests must contain a
x-api-key header with your API KeyJust 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.
Last modified 1mo ago