Ключ, по которому пришёл запрос (кто я)

Только по ключу API: его организация, компании, права, срок, месячный потолок и расход за текущий месяц, частота запросов. Публичные id компаний и организации — те, что принимают адреса API.

Доступно по ключу API.

GET /v1/api-key

Ключ, по которому пришёл запрос (кто я)

cURL

curl --request GET \
  --url https://api.tungo.kz/v1/api-key \
  --header 'x-api-key: <api-key>'

200

{
  "id": "key_01h455vb4pex5vsknk084sn02q",
  "name": "Интеграция с CRM",
  "prefix": "tg_ab12cd34ef56",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "created_by": "<string>",
  "company_ids": [
    "<string>"
  ],
  "all_companies": true,
  "allowed_ips": [
    "203.0.113.10",
    "198.51.100.0/24"
  ],
  "permissions": [
    "company.read"
  ],
  "status": "active",
  "expires_at": "2026-10-05T09:30:00.000Z",
  "monthly_cap_tiyn": 123,
  "write_max_amount_per_document_tiyn": 123,
  "write_max_amount_per_day_tiyn": 123,
  "write_kinds": [
    "<string>"
  ],
  "created_at": "2026-10-05T09:30:00.000Z",
  "last_used_at": "2026-10-05T09:30:00.000Z",
  "last_used_ip": "203.0.113.10",
  "revoked_at": "2026-10-05T09:30:00.000Z",
  "disabled_at": "2026-10-05T09:30:00.000Z",
  "previous_secret_valid_until": "2026-10-05T09:30:00.000Z",
  "blocked_reason": "key_revoked",
  "workspace": {
    "id": "<string>",
    "name": "ТОО «Пример»",
    "kind": "personal"
  },
  "month": {
    "month": "2026-11-01",
    "spent_tiyn": 123,
    "cap_tiyn": 123
  },
  "rate_limit": {
    "limit_per_minute": 123,
    "remaining": 123,
    "reset_in_sec": 123
  }
}

Авторизации

apiKeybearerKey

x-api-key · string · header · обязательно

Ключ API организации: x-api-key: tg_…. Для серверных интеграций, не для кабинета: ключ — секрет, из браузера его не слать (CORS закрыт). Какие адреса пускают по ключу — x-api-key-access у операции.

Ответ

200

application/json

Ключ

Ключ, по которому пришёл запрос: права, организация, расход за месяц, частота.

id · string · обязательно

id ключа (key_…) — для адресов …/api-keys/{id}

Пример:

"key_01h455vb4pex5vsknk084sn02q"

name · string · обязательно

Название ключа для людей

Пример:

"Интеграция с CRM"

prefix · string · обязательно

Открытая часть ключа для показа — узнать ключ среди других; сам ключ (tg_…_секрет) целиком не хранится

Пример:

"tg_ab12cd34ef56"

workspace_id · string · обязательно

Организация ключа (ws_…)

Пример:

"ws_01h455vb4pex5vsknk084sn02q"

created_by · string · обязательно

Кто выпустил (usr_…). Ключ действует от его имени и не шире его прав: создатель перестал быть владельцем или админом — ключ не работает

company_ids · string[] · обязательно

Компании, к которым ключ даёт доступ (co_…); пусто у ключа на все компании (all_companies)

all_companies · boolean · обязательно

Ключ на все компании организации, в том числе будущие: те, где создатель ключа состоит сейчас, и в каждой — не шире его текущей роли

allowed_ips · string[] | null · обязательно

С каких IP и подсетей CIDR ключ работает; с другого адреса — 403 ip_not_allowed. null — с любых

Пример:

["203.0.113.10", "198.51.100.0/24"]

permissions · enum<string>[] · обязательно

Права ключа: company.read — читать данные компаний (есть всегда); chat.use — работать с ИИ-бухгалтером; proposals.create — готовить документы для 1С; proposals.approve — одобрять запись в 1С; automations.read — видеть автоматизации; automations.manage — менять и запускать автоматизации; webhooks.manage — вебхуки всей организации

Доступные опции: company.read, chat.use, proposals.create, proposals.approve, automations.manage, automations.read, webhooks.manage

status · enum<string> · обязательно

Состояние: active — действует; disabled — выключен (disabled_at), не работает, можно включить; expired — истёк срок (expires_at), не работает; revoked — отозван (revoked_at), не работает. Неактивные показывать серыми

Доступные опции: active, disabled, expired, revoked

expires_at · string<date-time> · обязательно

Когда ключ перестаёт действовать, ISO 8601 UTC (срок есть у каждого ключа)

Пример:

"2026-10-05T09:30:00.000Z"

monthly_cap_tiyn · integer | null · обязательно

Месячный потолок расхода ИИ по ключу в тиынах (1 ₸ = 100 тиын; показывать значение / 100 ₸), календарный месяц по Алматы; null — без потолка ключа

write_max_amount_per_document_tiyn · integer | null · обязательно

Предел записи в 1С по ключу: потолок суммы одного документа, который ключ одобряет (approve, approve-batch), в тиынах (1 ₸ = 100 тиын). Документ дороже или без известной суммы ключ не запишет (403, error.code key_write_limit) — его запишет человек. null — без предела

write_max_amount_per_day_tiyn · integer | null · обязательно

Предел записи в 1С по ключу: сумма всех документов, одобренных ключом за день по Алматы, в тиынах. Документ с неизвестным исходом записи (1С не ответила) тоже считается. null — без предела

write_kinds · string[] | null · обязательно

Предел записи в 1С по ключу: какие виды документов ключ может одобрять (как kinds правила автоодобрения: sale, purchase, bank_receipt, bank_payment, counterparty, contract, inventory_writeoff, cash_order_in, cash_order_out, advance_report, revert). null — любые. Без всех трёх пределов ключ с proposals.approve пишет в 1С без ограничений — тогда в ответе предупреждение write_unlimited

created_at · string<date-time> · обязательно

Когда выпущен, ISO 8601 UTC

Пример:

"2026-10-05T09:30:00.000Z"

last_used_at · string<date-time> | null · обязательно

Когда ключом пользовались последний раз, ISO 8601 UTC (точность — около минуты); null — ещё ни разу

Пример:

"2026-10-05T09:30:00.000Z"

last_used_ip · string | null · обязательно

С какого IP-адреса был последний запрос; null — ещё ни разу

Пример:

"203.0.113.10"

revoked_at · string<date-time> | null · обязательно

Когда отозван, ISO 8601 UTC; null — не отозван

Пример:

"2026-10-05T09:30:00.000Z"

disabled_at · string<date-time> | null · обязательно

Когда выключен, ISO 8601 UTC; null — не выключен

Пример:

"2026-10-05T09:30:00.000Z"

previous_secret_valid_until · string<date-time> | null · обязательно

После смены секрета (roll): до какого времени ещё действует прежний, ISO 8601 UTC; null — прежнего нет

Пример:

"2026-10-05T09:30:00.000Z"

blocked_reason · enum<string> | null · обязательно

Почему ключ сейчас не сработает — тот же код, что вернул бы отказ; null — всё хорошо. Вызов ИИ оценивается средней ценой, настоящая цена может быть выше. Ограничение по адресу (allowed_ips) здесь не проверяется: оно своё у каждого запроса. По самому ключу код входа (выключен, срок, отзыв) приходит ошибкой 401, а не этим полем.

Доступные опции: key_revoked, key_expired, key_disabled, key_creator_lost_access, api_keys_disabled_by_policy, workspace_blocked, key_cap_reached, platform_balance_exhausted, platform_cap_reached, platform_disabled, null

workspace · object · обязательно

Организация, которой принадлежит ключ

Show child attributes

month · object · обязательно

Расход ключа за текущий месяц и его потолок — для полосы «потрачено из».

Show child attributes

rate_limit · object | null · обязательно

Частота запросов: самый тесный предел из ключа и организации (то же, что заголовки x-ratelimit-*); null — счётчика у запроса нет

Show child attributes