Документация API

Nordic Layers — это REST API по HTTPS на https://app.layers.nordicbyte.co.uk. Проект — JSON-документ со слоями; вы меняете его операциями и экспортируете как изображение. Браузерный редактор использует тот же API.

Аутентификация

Создайте ключ API в личном кабинете и отправляйте его с каждым запросом /v1. Ключи начинаются с nl_key_.

Authorization: Bearer nl_key_…

Обычный порядок работы

1. Загрузите каждое изображение через POST /v1/assets, передав файл как тело запроса (PNG, JPEG, WebP, GIF, BMP или TIFF). В ответе будет его id.
2. Создайте проект через POST /v1/projects с width, height и background. Первые steps можно передать в том же вызове.
3. Редактируйте через POST /v1/projects/{id}/run: одна операция в виде {"op": …} или несколько в виде {"steps": [...]}. Смотрите результат через GET /v1/projects/{id}/preview, это бесплатно.
4. Экспортируйте через POST /v1/projects/{id}/export. В ответе будет URL файла или само изображение при "response": "image".

Первый запрос

Создайте проект 1080×1080 с градиентом и заголовком, затем экспортируйте его в 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
  }'

Эндпоинты

Операции

Каждая операция — объект с op и её параметрами. На слои ссылаются по id или по имени; без layer используется активный слой. Имена не зависят от регистра и пробелов, поэтому "Linear Dodge (Add)" и "linearDodge" — один и тот же режим наложения. С steps они выполняются по порядку и останавливаются на первой ошибке (если не задано "stopOnError": false); предыдущие шаги остаются применёнными.

• Слои
• Текст
• Фигуры
• Трансформация
• Коррекции слоя
• Фильтры
• Корректирующие слои
• Маски слоя
• Эффекты слоёв
• Холст
• Проект

Слои

Текст

Фигуры

Трансформация

Коррекции слоя

Фильтры

Корректирующие слои

Маски слоя

Эффекты слоёв

Холст

Проект

Режимы наложения

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

Семейства шрифтов

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

Шаблоны

Передайте steps в вызов экспорта, и они применятся к копии проекта только для этого файла. Один шаблон, много файлов: меняйте текст через text.set, а фото через layer.setImage, который сохраняет рамку слоя.

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

Рендер без состояния

POST /v1/render принимает целый document (в том виде, как он возвращается в project.document), необязательные steps и параметры экспорта, и не сохраняет проект. При "response": "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

Ошибки

Ошибки возвращаются в JSON со стабильным code и сообщением detail на языке вашего аккаунта. Неудавшийся шаг сообщает, какой параметр был неверным. Когда рендеры тарифа закончились, API отвечает 402 с quota_renders.

Лимиты

• Загрузки до 50 MB и 12,000 px по стороне.
• Холст до 20,000 px по стороне, в пределах мегапикселей вашего тарифа.
• До 200 шагов за вызов.
• Предпросмотры до 2,048 px по длинной стороне.
• Мегапиксели, слои, проекты, хранилище и рендеры в месяц зависят от тарифа: см. «Цены».