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.
How to get an API Key?
Access to the API key requires at least an Admin role.
Go to app.abyssale.com & log in
Click
Workspace settingson the left menuClick
API Keyon the left menuClick the green
Create new API keybutton.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 Key
How to test your authentication?
Just call the GET /ready route with the header mentioned below, as follows:
curl -i -H "x-api-key: {YOUR-API-KEY}" https://api.abyssale.com/ready # HTTP/2 200const 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 # 200If the status code received is a 200, everything is OK.
Last updated