Справочник API
Организации
Обновление профиля организации и сводка для кабинета.
Кому подходит
- Администраторам — название, реквизиты плательщика (ИНН, КПП, адрес, банк) и сводка кабинета.
- Интеграторам — загрузка overview одним запросом.
Требуется Bearer-токен. Endpoints изменения — роли owner или admin.
GET /api/overview
Сводка личного кабинета для текущего участника.
curl -s https://api.example.com/api/overview \
-H "Authorization: Bearer <token>"Ответ 200 — основные поля:
| Поле | Описание |
|---|---|
organization | Профиль организации |
members | Участники |
invitations | Приглашения |
apiKeys | API-ключи (метаданные) |
authProviders | Способы входа |
usage | Сводка расходов |
usageTrend | Точки для графика |
billing | Коммерческий биллинг (баланс, счета) |
auditEvents | До 10 последних событий |
gateway | Статус API моделей |
models | Каталог моделей |
policyRuleCount | Число policy rules организации |
capabilities | Список возможностей продукта |
Ошибки: 401 — не авторизован; 404 — организация для email не найдена.
PATCH /api/organizations/{orgId}
Обновление организации.
Тело:
| Поле | Тип | Описание |
|---|---|---|
legalName | string | Новое название (если не пусто) |
legalDetails | object | Реквизиты плательщика (см. ниже) |
Лимиты расходов и доступ к моделям настраиваются через Policy Rules, а не полями организации.
legalDetails:
| Поле | Тип | Описание |
|---|---|---|
inn | string | ИНН: 10 цифр (юрлицо) или 12 (ИП) |
kpp | string | КПП (9 цифр), обязателен при ИНН из 10 цифр |
ogrn | string | ОГРН / ОГРНИП (опционально) |
legalAddress | string | Юридический адрес |
actualAddress | string | Фактический адрес (опционально) |
bankName | string | Наименование банка |
bik | string | БИК (9 цифр) |
settlementAccount | string | Расчётный счёт (20 цифр) |
correspondentAccount | string | Корр. счёт (20 цифр) |
При выставлении счёта на пополнение (POST .../billing/top-ups) реквизиты должны быть заполнены. На каждом счёте сохраняется снимок buyerLegal на момент выставления.
curl -s -X PATCH https://api.example.com/api/organizations/org_abc \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"legalName":"ООО Пример","legalDetails":{"inn":"7707083893","kpp":"770701001","legalAddress":"г. Москва, ул. Примерная, 1"}}'Ответ 200 — объект Organization:
{
"id": "org_abc",
"legalName": "Новое название",
"slug": "demo-organization",
"accountType": "business",
"legalDetails": {
"inn": "7707083893",
"kpp": "770701001",
"legalAddress": "г. Москва, ул. Примерная, 1"
}
}Ошибки:
| Код | Причина |
|---|---|
| 401 | Сессия не найдена |
| 403 | Недостаточно прав |
| 404 | Организация не найдена |
| 400 | Некорректный JSON или бизнес-ошибка |
Создаётся запись аудита organization.updated.