API-Dokumentation

Nordic Layers ist eine REST-API über HTTPS unter https://app.layers.nordicbyte.co.uk. Ein Projekt ist ein JSON-Dokument aus Ebenen; Sie ändern es mit Operationen und exportieren es als Bild. Der Browser-Editor nutzt dieselbe API.

Authentifizierung

Erstellen Sie in Ihrem Kontobereich einen API-Schlüssel und senden Sie ihn bei jeder /v1-Anfrage mit. Schlüssel beginnen mit nl_key_.

Authorization: Bearer nl_key_…

Der übliche Ablauf

1. Laden Sie jedes Bild mit POST /v1/assets hoch, die Datei als roher Request-Body (PNG, JPEG, WebP, GIF, BMP oder TIFF). Die Antwort enthält die id.
2. Erstellen Sie ein Projekt mit POST /v1/projects sowie width, height und background. Die ersten steps können Sie im selben Aufruf mitgeben.
3. Bearbeiten Sie es mit POST /v1/projects/{id}/run: eine Operation als {"op": …} oder mehrere als {"steps": [...]}. Ansehen können Sie es mit GET /v1/projects/{id}/preview, das kostenlos ist.
4. Exportieren Sie mit POST /v1/projects/{id}/export. Die Antwort enthält die Datei-URL oder mit "response": "image" das Bild selbst.

Eine erste Anfrage

Erstellen Sie ein 1080×1080-Projekt mit einem Verlauf und einem Titel und exportieren Sie es als 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
  }'

Endpunkte

Operationen

Jede Operation ist ein Objekt mit op und ihren Parametern. Ebenen werden über id oder Namen angesprochen; ohne layer wird die aktive Ebene verwendet. Namen ignorieren Groß-/Kleinschreibung und Leerzeichen, daher sind "Linear Dodge (Add)" und "linearDodge" dieselbe Füllmethode. Mit steps laufen sie der Reihe nach und stoppen beim ersten Fehler (außer bei "stopOnError": false); die Schritte davor bleiben angewendet.

• Ebenen
• Text
• Formen
• Transformieren
• Korrekturen auf einer Ebene
• Filter
• Einstellungsebenen
• Ebenenmasken
• Ebeneneffekte
• Arbeitsfläche
• Projekt

Ebenen

Text

Formen

Transformieren

Korrekturen auf einer Ebene

Filter

Einstellungsebenen

Ebenenmasken

Ebeneneffekte

Arbeitsfläche

Projekt

Füllmethoden

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

Schriftfamilien

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

Vorlagen

Übergeben Sie steps an den Export-Aufruf, und sie werden nur für diese Datei auf eine Kopie des Projekts angewendet. Eine Vorlage, viele Dateien: Ändern Sie den Text mit text.set und das Foto mit layer.setImage, das die Box der Ebene beibehält.

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"}
    ]
  }'

Zustandsloser Render

POST /v1/render nimmt ein ganzes document (wie in project.document zurückgegeben), optionale steps und die Exportoptionen entgegen und speichert kein Projekt. Mit "response": "image" ist die Antwort die Bilddatei.

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

Fehler

Fehler kommen als JSON mit einem stabilen code und einer detail-Meldung in der Sprache Ihres Kontos zurück. Ein fehlschlagender Schritt nennt den fehlerhaften Parameter. Sind die Renders eines Tarifs aufgebraucht, antwortet die API mit 402 und quota_renders.

Limits

• Uploads bis 50 MB und 12,000 px pro Seite.
• Arbeitsfläche bis 20,000 px pro Seite, innerhalb der Megapixel Ihres Tarifs.
• Bis zu 200 Schritte pro Aufruf.
• Vorschauen bis 2,048 px an der langen Seite.
• Megapixel, Ebenen, Projekte, Speicher und Renders pro Monat hängen vom Tarif ab: siehe Preise.