Documentation de l'API

Nordic Layers est une API REST sur HTTPS à l'adresse https://app.layers.nordicbyte.co.uk. Un projet est un document JSON de calques ; vous le modifiez avec des opérations et l'exportez sous forme d'image. L'éditeur du navigateur utilise la même API.

Authentification

Créez une clé d'API dans le panneau de votre compte et envoyez-la avec chaque requête /v1. Les clés commencent par nl_key_.

Authorization: Bearer nl_key_…

Le déroulement habituel

1. Importez chaque image avec POST /v1/assets et le fichier comme corps brut de la requête (PNG, JPEG, WebP, GIF, BMP ou TIFF). La réponse contient son id.
2. Créez un projet avec POST /v1/projects et un width, height et background. Vous pouvez passer les premiers steps dans le même appel.
3. Modifiez-le avec POST /v1/projects/{id}/run : une opération sous la forme {"op": …} ou plusieurs sous la forme {"steps": [...]}. Consultez-le avec GET /v1/projects/{id}/preview, qui est gratuit.
4. Exportez avec POST /v1/projects/{id}/export. La réponse contient l'URL du fichier, ou l'image elle-même avec "response": "image".

Une première requête

Créez un projet de 1080×1080 avec un dégradé et un titre, puis exportez-le en WebP :

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "First post",
    "width": 1080,
    "height": 1080,
    "steps": [
      {"op": "layer.addFill", "gradient": {"colors": ["#1E3A5F", "#64B5F6"], "angle": 135}},
      {"op": "text.add", "content": "Hello, layers", "fontName": "Segoe UI", "fontSize": 110, "bold": true, "color": "#FFFFFF"},
      {"op": "effects.set", "shadow": {"opacity": 0.4, "distance": 12, "size": 24}}
    ]
  }'

# → {"project": {"id": "…", …}}

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects/$PROJECT_ID/export \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "webp",
    "quality": 90
  }'

Endpoints

Opérations

Chaque opération est un objet avec op et ses paramètres. Les calques sont désignés par id ou par nom ; sans layer, le calque actif est utilisé. Les noms ignorent la casse et les espaces : "Linear Dodge (Add)" et "linearDodge" désignent donc le même mode de fusion. Avec steps, elles s'exécutent dans l'ordre et s'arrêtent à la première erreur (sauf avec "stopOnError": false) ; les étapes précédentes restent appliquées.

• Calques
• Texte
• Formes
• Transformation
• Réglages sur un calque
• Filtres
• Calques de réglage
• Masques de calque
• Effets de calque
• Zone de travail
• Projet

Calques

Texte

Formes

Transformation

Réglages sur un calque

Filtres

Calques de réglage

Masques de calque

Effets de calque

Zone de travail

Projet

Modes de fusion

• normal
• darken
• multiply
• colorBurn
• linearBurn
• lighten
• screen
• colorDodge
• linearDodge
• overlay
• softLight
• hardLight
• difference
• exclusion
• subtract
• divide
• hue
• saturation
• color
• luminosity

Familles de polices

• Arial
• Segoe UI
• Calibri
• Verdana
• Tahoma
• Trebuchet MS
• Georgia
• Times New Roman
• Courier New
• Consolas
• Impact
• Comic Sans MS

Modèles

Passez steps à l'appel d'export et ils sont appliqués à une copie du projet pour ce seul fichier. Un modèle, de nombreux fichiers : changez le texte avec text.set et la photo avec layer.setImage, qui conserve la boîte du calque.

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects/$TEMPLATE_ID/export \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "png",
    "steps": [
      {"op": "text.set", "layer": "Title", "content": "Nueva colección"},
      {"op": "layer.setImage", "layer": "Photo", "asset_id": "photo_dunes"}
    ]
  }'

Rendu sans état

POST /v1/render prend un document entier (tel que renvoyé dans project.document), des steps facultatifs et les options d'export, et n'enregistre aucun projet. Avec "response": "image", la réponse est le fichier image.

curl -X POST https://app.layers.nordicbyte.co.uk/v1/render \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": {"width": 1200, "height": 630, "background": "#1E3A5F", "layers": ["…"]},
    "format": "png",
    "response": "image"
  }' \
  -o card.png

Erreurs

Les erreurs sont renvoyées en JSON avec un code stable et un message detail dans la langue de votre compte. Une étape en échec indique quel paramètre était incorrect. Quand les rendus d'un forfait sont épuisés, l'API répond 402 avec quota_renders.

Limites

• Imports jusqu'à 50 Mo et 12,000 px par côté.
• Zone de travail jusqu'à 20,000 px par côté, dans la limite des mégapixels de votre forfait.
• Jusqu'à 200 étapes par appel.
• Aperçus jusqu'à 2,048 px sur le grand côté.
• Les mégapixels, calques, projets, le stockage et les rendus par mois dépendent du forfait : voir Tarifs.