Documentação da API

O Nordic Layers é uma API REST sobre HTTPS em https://app.layers.nordicbyte.co.uk. Um projeto é um documento JSON de camadas; você o altera com operações e o exporta como imagem. O editor do navegador usa a mesma API.

Autenticação

Crie uma chave de API no painel da sua conta e envie-a em toda requisição a /v1. As chaves começam com nl_key_.

Authorization: Bearer nl_key_…

O fluxo habitual

1. Envie cada imagem com POST /v1/assets e o arquivo como corpo bruto da requisição (PNG, JPEG, WebP, GIF, BMP ou TIFF). A resposta traz o id dela.
2. Crie um projeto com POST /v1/projects e um width, height e background. Você pode passar os primeiros steps na mesma chamada.
3. Edite com POST /v1/projects/{id}/run: uma operação como {"op": …} ou várias como {"steps": [...]}. Confira com GET /v1/projects/{id}/preview, que é gratuito.
4. Exporte com POST /v1/projects/{id}/export. A resposta traz a URL do arquivo, ou a própria imagem com "response": "image".

Uma primeira requisição

Crie um projeto de 1080×1080 com um degradê e um título, e exporte-o como 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

Operações

Toda operação é um objeto com op e seus parâmetros. As camadas são referenciadas por id ou por nome; sem layer, usa-se a camada ativa. Os nomes ignoram maiúsculas e espaços, então "Linear Dodge (Add)" e "linearDodge" são o mesmo modo de mesclagem. Com steps, eles rodam em ordem e param no primeiro erro (a não ser que "stopOnError": false); os passos anteriores continuam aplicados.

• Camadas
• Texto
• Formas
• Transformar
• Ajustes em uma camada
• Filtros
• Camadas de ajuste
• Máscaras de camada
• Efeitos de camada
• Tela
• Projeto

Camadas

Texto

Formas

Transformar

Ajustes em uma camada

Filtros

Camadas de ajuste

Máscaras de camada

Efeitos de camada

Tela

Projeto

Modos de mesclagem

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

Famílias de fontes

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

Modelos

Passe steps para a chamada de exportação e eles são aplicados a uma cópia do projeto só para aquele arquivo. Um modelo, muitos arquivos: mude o texto com text.set e a foto com layer.setImage, que mantém a caixa da camada.

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 sem estado

POST /v1/render recebe um document inteiro (como devolvido em project.document), steps opcionais e as opções de exportação, e não salva um projeto. Com "response": "image" a resposta é o arquivo de imagem.

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

Erros

Os erros voltam como JSON com um code estável e uma mensagem detail no idioma da sua conta. Um passo que falha informa qual parâmetro estava errado. Quando os renders de um plano acabam, a API responde 402 com quota_renders.

Limites

• Uploads de até 50 MB e 12,000 px por lado.
• Tela de até 20,000 px por lado, dentro dos megapixels do seu plano.
• Até 200 passos por chamada.
• Prévias de até 2,048 px no lado maior.
• Megapixels, camadas, projetos, armazenamento e renders por mês dependem do plano: veja Preços.