С чего начать работу с API

Это вход в внешний API: один адрес, ключ в заголовке и методы контент-завода, каталога, фотостудии, файлов, базы знаний и AI-оператора. Ключ принадлежит вам и одному проекту. Чужие проекты и чужие ключи этим запросом не открыть.

Базовый URL

Прод: https://api-external.brifly.online
Локально порт из PORT, по умолчанию 5102

Где взять ключ

В кабинете: Настройки → API. Ключ показывается один раз. В ключе можно выдать только scopes контент-завода, каталога, фотостудии, файлов и задач AI.

Запрос и ответ

Каждый метод — POST /v1/<путь>. В теле объект data, в ответе success и data. Целый вызов с полями — в примере ниже.

Чего здесь нет

Вход, пароль, оплата, админка, счета, транзакции, партнёрка, поддержка, уведомления и звонки оператора в этот API не входят. Их меняют в кабинете.

Учебный пример магазина «Северная полка». Это не запись из вашей базы. Ниже тот же вызов, с которого обычно начинают: список задач контент-завода.

Запрос

{
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "page": 1,
    "pageSize": 20
  }
}

Ответ (успех, 200)

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "33333333-3333-4333-8333-333333333333",
        "title": "Пост про кружку к выходным",
        "description": "Короткий текст для карточки, тон спокойный.",
        "status": "in_progress",
        "priority": "normal",
        "channel": "site",
        "scenarioType": "product_post",
        "templateId": "22222222-2222-4222-8222-222222222222",
        "productId": "55555555-5555-4555-8555-555555555555",
        "product": {
          "id": "55555555-5555-4555-8555-555555555555",
          "name": "Кружка эмаль, 350 мл"
        },
        "template": {
          "id": "22222222-2222-4222-8222-222222222222",
          "title": "Короткий пост для витрины"
        },
        "messageTextsCount": 1,
        "archivedAt": null,
        "projectId": "11111111-1111-4111-8111-111111111111",
        "createdAt": "2026-10-16T09:00:00.000Z",
        "updatedAt": "2026-10-16T09:12:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 20
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/&lt;путь&gt;" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: {{api_key}}" \
  -d '{"data": {"projectId": "11111111-1111-4111-8111-111111111111", "page": 1, "pageSize": 20}}'