Platform
Help center
Search…
Getting Started
Rest API
Overview - Rest API
Authentication
Templates
Image Generation
Image Export
Fonts
API Reference
Dynamic Images
Overview - Dynamic Images
Image generation
Webhooks
Overview - Webhooks
Events
Powered By
GitBook
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?
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
1
curl -i -H "x-api-key: {YOUR-API-KEY}" https://api.abyssale.com/ready # HTTP/2 200
Copied!
1
const
axios
=
require
(
'axios'
);
2
​
3
axios
.
get
(
"https://api.abyssale.com/ready"
,
{
headers
:
{
"x-api-key"
:
"{YOUR-API-KEY}"
}}).
then
(
response
=>
{
4
console
.
log
(
response
.
status
)
// 200
5
})
Copied!
1
import
requests
2
​
3
r
=
requests
.
get
(
"https://api.abyssale.com/ready"
,
headers
=
{
"x-api-key"
:
"{YOUR-API-KEY}"
},
timeout
=
30
)
4
r
.
status_code
# 200
Copied!
If the status code received is a
200
, everything is OK.
Rest API - Previous
Overview - Rest API
Next - Rest API
Templates
Last modified
26d ago
Copy link
Contents
How to get an API Key?
How to test your authentication?