Abyssale Developer Hub
  • Getting Started
  • Rest API
    • Overview - Rest API
    • Authentication
    • Designs
      • Design Details
    • Generation
      • Design information
      • Synchronous generation
        • Generate single image
      • Asynchronous generation
        • Generate Multi-Format images
        • Generate Multi-Format PDFs for Printing
        • Generate Multi-Page PDF for Printing
        • Generate Multi-Format Videos
        • Generate Multi-Format Animated GIFs
        • Generate HTML5 Banner Ads
          • ad network
      • Element properties
        • Root
        • Text
        • Button
        • Image
        • Logo
        • Shape
        • Rating
        • Illustration
        • QR Code
        • Video
        • Audio
      • Errors
    • Image Export
    • Fonts
    • Annexes
    • API Reference
  • Dynamic Images
    • Overview - Dynamic Images
    • Dynamic Image generation with URL
  • Webhooks
    • Overview - Webhooks
    • Events
      • Design
      • Banner
      • Global events
Powered by GitBook
On this page
  • How to get an API Key?
  • How to test your authentication?
  1. Rest API

Authentication

Authentication - Abyssale REST API

PreviousOverview - Rest APINextDesigns

Last updated 5 months ago

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.

  1. Go to & log in

  2. Click Workspace settings on the left menu

  3. Click API Key on the left menu

  4. Click the green Create new API key button.

  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 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 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.

app.abyssale.com
Workspace settings
Create new API key