Справочник REST API

API построен по принципам REST, ответы возвращаются в JSON. Аутентификация — по токену в заголовке Authorization: Bearer <token>.

Базовые адреса

Метод	Путь	Описание
GET	/api/v1/diagrams	Список диаграмм рабочей области
POST	/api/v1/diagrams	Создание новой диаграммы
GET	/api/v1/diagrams/{id}	Получение диаграммы по идентификатору
PUT	/api/v1/diagrams/{id}	Обновление диаграммы
GET	/api/v1/diagrams/{id}/export?format=xml	Экспорт в BPMN 2.0 XML
GET	/api/v1/diagrams/{id}/versions	История версий

Пример запроса

curl -H "Authorization: Bearer $TOKEN" \
     https://app.bpmn123.ru/api/v1/diagrams

Ответ

{
  "items": [
    {
      "id": "dgm_8f31a2",
      "name": "Согласование договора",
      "updated_at": "2026-08-01T12:40:11Z",
      "versions": 14
    }
  ],
  "total": 1
}

Лимиты

Для облачных тарифов действует ограничение 600 запросов в минуту на токен. При превышении API возвращает код 429 и заголовок Retry-After.