Dokumentasi API

Nordic Layers adalah REST API lewat HTTPS di https://app.layers.nordicbyte.co.uk. Proyek adalah dokumen JSON berisi layer; Anda mengubahnya dengan operasi dan mengekspornya sebagai gambar. Editor browser memakai API yang sama.

Autentikasi

Buat API key di panel akun Anda dan kirim pada setiap permintaan /v1. Key diawali dengan nl_key_.

Authorization: Bearer nl_key_…

Alur yang biasa

1. Unggah setiap gambar dengan POST /v1/assets dan file sebagai body mentah permintaan (PNG, JPEG, WebP, GIF, BMP, atau TIFF). Responsnya membawa id-nya.
2. Buat proyek dengan POST /v1/projects beserta width, height, dan background. Anda bisa menyertakan steps pertama dalam panggilan yang sama.
3. Edit dengan POST /v1/projects/{id}/run: satu operasi sebagai {"op": …} atau beberapa sebagai {"steps": [...]}. Lihat hasilnya dengan GET /v1/projects/{id}/preview, yang gratis.
4. Ekspor dengan POST /v1/projects/{id}/export. Responsnya berisi URL file, atau gambarnya langsung dengan "response": "image".

Permintaan pertama

Buat proyek 1080×1080 dengan gradien dan judul, lalu ekspor sebagai 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
  }'

Endpoint

Operasi

Setiap operasi adalah objek dengan op dan parameternya. Layer dirujuk lewat id atau nama; tanpa layer, layer aktif yang dipakai. Nama tidak membedakan huruf besar-kecil dan spasi, jadi "Linear Dodge (Add)" dan "linearDodge" adalah mode blending yang sama. Dengan steps, operasi dijalankan berurutan dan berhenti pada kesalahan pertama (kecuali "stopOnError": false); langkah sebelumnya tetap diterapkan.

• Layer
• Teks
• Bentuk
• Transformasi
• Penyesuaian pada layer
• Filter
• Layer penyesuaian
• Layer mask
• Efek layer
• Kanvas
• Proyek

Layer

Teks

Bentuk

Transformasi

Penyesuaian pada layer

Filter

Layer penyesuaian

Layer mask

Efek layer

Kanvas

Proyek

Mode blending

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

Keluarga font

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

Template

Sertakan steps pada panggilan ekspor dan langkah itu diterapkan ke salinan proyek hanya untuk file tersebut. Satu template, banyak file: ganti teks dengan text.set dan foto dengan layer.setImage, yang mempertahankan kotak layer.

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

Render stateless

POST /v1/render menerima seluruh document (seperti yang dikembalikan di project.document), steps opsional, dan opsi ekspor, serta tidak menyimpan proyek. Dengan "response": "image" responsnya adalah file gambar.

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

Kesalahan

Kesalahan dikembalikan sebagai JSON dengan code yang stabil dan pesan detail dalam bahasa akun Anda. Langkah yang gagal melaporkan parameter mana yang salah. Saat render pada suatu paket habis, API menjawab 402 dengan quota_renders.

Batasan

• Unggahan hingga 50 MB dan 12,000 px per sisi.
• Kanvas hingga 20,000 px per sisi, dalam batas megapiksel paket Anda.
• Hingga 200 langkah per panggilan.
• Pratinjau hingga 2,048 px pada sisi terpanjang.
• Megapiksel, layer, proyek, penyimpanan, dan render per bulan bergantung pada paket: lihat Harga.