GET
/me Доступно#Кто я
Возвращает арендатора, интеграцию, ключ с действующими областями, пределы частоты и состояние кошелька. Областей не требует: нужен лишь действующий ключ. Удобно для проверки подключения и для выбора ячейки.
Тело ответа
| Поле | Тип | Описание |
|---|---|---|
tenant | object обязательное | Арендатор — владелец ключа. |
tenant.id | string обязательное | |
tenant.name | string обязательное | |
cell | string обязательное | Ячейка платформы: ru, en или id. Значения: ru en id |
base_url | string обязательное | Базовый адрес API этой ячейки. |
integration | object обязательное | Интеграция (служебная учётная запись), которой принадлежит ключ. |
integration.id | string обязательное | |
integration.name | string обязательное | |
channel_id | string обязательное, может быть null | Канал "api" интеграции; null — канал ещё не создан. |
key | object обязательное | |
key.key_id | string обязательное | Публичный идентификатор ключа (не секрет). |
key.mode | string обязательное | Значения: live test |
key.scopes | array<string> обязательное | Действующие области: область интеграции ∩ текущие права владельца ∩ лицензия. Значения: conversations:read conversations:write ai_seller:invoke leads:read leads:write leads:score analytics:read analytics:write dashboards:read articles:read articles:write articles:generate strategist:read strategist:write strategist:chat webhooks:manage |
key.expires_at | string обязательное | Срок действия ключа, ISO 8601 UTC. |
key.ip_allowlist | array<string> обязательное, может быть null | Разрешённые адреса и сети (CIDR); null — любой адрес. |
limits | object обязательное | Пределы частоты запросов. |
limits.read_per_min | integer обязательное | |
limits.write_per_min | integer обязательное | |
limits.paid_per_min | integer обязательное | |
limits.paid_concurrency | integer обязательное | Одновременных платных операций на арендатора. |
wallet | object обязательное | Кошелёк арендатора (ИИ-операции). |
wallet.balance | Money обязательное, может быть null | Остаток кошелька в рублях; null — состояние неизвестно или арендатор не тарифицируется. |
wallet.state | string обязательное | ok — достаточно; low — мало средств; negative — остаток ниже нуля; blocked — кошелёк заблокирован; unknown — состояние получить не удалось. Подробности — GET /wallet. Значения: ok low negative blocked unknown |
wallet.exchange | string обязательное | suspended при negative и blocked: все маршруты, кроме /me и /wallet, отвечают 402 wallet_suspended. Значения: active suspended |
wallet.topup_url | string обязательное | Адрес кабинета, где пополняется кошелёк. |
wallet.daily_spend | object обязательное | |
wallet.daily_spend.limit | Money обязательное, может быть null | Суточный предел трат интеграции; null — не задан. |
wallet.daily_spend.used | Money обязательное | |
crm_mode | string обязательное | Режим CRM арендатора: "internal" (наша CRM) или внешняя система. |
Примеры
Запрос
curl -X GET 'https://formula-cream.pro/api/public/v1/me' \
-H 'Authorization: Bearer '"$SAPPORT_API_KEY"Ответ 200
{
"tenant": {
"id": "EXAMPLE_ID",
"name": "string"
},
"cell": "ru",
"base_url": "https://example.com/hooks/sapport",
"integration": {
"id": "EXAMPLE_ID",
"name": "string"
},
"channel_id": "EXAMPLE_ID",
"key": {
"key_id": "EXAMPLE_ID",
"mode": "live",
"scopes": [
"conversations:read"
],
"expires_at": "2026-10-11T09:00:00Z",
"ip_allowlist": [
"string"
]
},
"limits": {
"read_per_min": 0,
"write_per_min": 0,
"paid_per_min": 0,
"paid_concurrency": 0
},
"wallet": {
"balance": {
"amount": null,
"currency": null
},
"state": "ok",
"exchange": "active",
"topup_url": "https://example.com/hooks/sapport",
"daily_spend": {
"limit": null,
"used": {
"amount": null,
"currency": null
}
}
},
"crm_mode": "string"
}Пример ошибки
{
"type": "https://formula-cream.pro/developers/errors#invalid_api_key",
"title": "Invalid API key",
"status": 401,
"code": "invalid_api_key",
"detail": "EXAMPLE",
"request_id": "req_EXAMPLE"
}Примеры иллюстративны: ключ в них условный (EXAMPLE), значения полей выдуманы.
Возможные ошибки
invalid_api_key wrong_cell integration_inactive tenant_inactive ip_not_allowed feature_not_in_plan rate_limited service_unavailable internal_error