Документация для разработчиков

Orbita предоставляет REST API для интеграции, автоматизации и расширения функциональности. Все операции, доступные в интерфейсе, можно выполнить через API.

Быстрый старт

1. Получить токен

curl -X POST https://app.orbita.example/api/login-local \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@example.com", "password": "secret"}'

Ответ:

{
  "token": "1|abc123...",
  "user": { "id": 1, "name": "Admin", "email": "admin@example.com" }
}

2. Выполнить запрос

curl https://app.orbita.example/api/e/it_requests \
  -H "Authorization: Bearer 1|abc123..."

Разделы

• Аутентификация — токены, SSO, OAuth, приглашения
• API сущностей — CRUD, bulk import, фильтрация
• Портальный API — работа с публичными порталами
• API отчётов — определения отчётов, экспорт, расписания рассылок
• BPMN-процессы — описание XML-структуры, типы узлов
• Скрипты и выражения — $api, SafeScriptRunner, ExpressionLanguage
• Вебхуки и интеграции — Telegram, входящие сообщения, IncomingActions
• Уведомления — шаблоны, отправка из скриптов
• Self-hosted (Docker) — развёртывание с нуля
• Переменные окружения — полный справочник .env

Формат ответов

{
  "success": true,
  "data": { ... },
  "message": "OK"
}

Ошибки валидации:

{
  "success": false,
  "message": "Validation error",
  "errors": {
    "email": ["Поле email обязательно"]
  }
}

HTTP-коды

Код	Значение
200	Успех
201	Создано
204	Удалено
401	Не авторизован
403	Нет доступа
404	Не найдено
422	Ошибка валидации
500	Ошибка сервера