API Orbix OS

Читайте свои данные из BI-системы, скрипта или таблицы. API доступен на уровне «Бизнес» и работает по ключу организации — тому же, что выдаётся в кабинете.

Авторизация

Ключ передаётся заголовком. В строке запроса ключ не принимается намеренно: URL попадает в логи прокси и историю браузера.

curl https://orbixos.ru/api/public/v1/ping \
  -H "Authorization: Bearer orbx_ваш_ключ"

# или
curl https://orbixos.ru/api/public/v1/ping -H "X-Api-Key: orbx_ваш_ключ"

Ключ создаётся в кабинете и показывается один раз — сохраните его сразу. Отозвать можно там же: отключённый ключ перестаёт работать немедленно.

Что можно

Только чтение. Запись через публичный ключ не открыта: ключ живёт в чужих скриптах, и цена его утечки ограничена просмотром.

GET/ping— Проверка ключа

Отвечает, что ключ рабочий, и возвращает идентификатор организации. С этого удобно начинать интеграцию.

{ "ok": true, "organizationId": "cm...", "version": "v1" }

GET/reports— Список отчётов

Какие отчёты можно забрать: код, название и назначение.

{ "reports": [ { "code": "pnl", "title": "Доходы и расходы по месяцам", "group": "finance" } ] }

GET/reports/:code— Данные отчёта

Колонки, строки и итог. Деньги — в копейках: так суммы не теряют копейки при делении. Параметры: from, to — границы периода в ISO. По умолчанию текущий год.

{
  "code": "pnl",
  "columns": [ { "key": "month", "title": "Месяц", "type": "text" } ],
  "rows": [ { "month": "июль 2026", "income": 8800000 } ],
  "totals": { "month": "Итого", "income": 8800000 },
  "summary": "Прибыль за период: 57 000 ₽ при рентабельности 64.8%."
}

GET/metrics— Значения показателей

Готовые метрики для BI: доходы, расходы, прибыль, рентабельность, остаток на счетах, сделки, склад, задачи, обращения. Параметры: codes — коды через запятую. Без параметра возвращаются все.

{ "metrics": [ { "code": "profit", "title": "Прибыль", "value": 5700000, "format": "money" } ] }

Ошибки

Код	HTTP	Что означает
`api_key_required`	401	Ключ не передан ни в одном из заголовков.
`api_key_invalid`	401	Ключ не найден или отключён в кабинете.
`module_locked`	402	Уровень аккаунта ниже «Бизнес» — API доступен только на нём.
`report_not_found`	404	Такого кода отчёта нет.
`bad_range`	400	Параметры from/to не разбираются как даты.

Версии

Версия зашита в путь (/v1) и возвращается в ответе /ping. Несовместимые изменения выйдут отдельной версией — уже написанные у вас скрипты продолжат работать.