Platitun · API · Ключи доступа · Выдать ключ

Выдать ключ

POST /api/v1/keys

Область ключа: keys · изменяет данные, нужен заголовок Idempotency-Key

Новый ключ доступа. Он показывается ОДИН раз — второго показа не будет, потому что мы его не знаем: в базе только свёртка.

🔴 Ключ не может выдать области, которых нет у него самого. Иначе один утёкший ключ с областью «keys» становился бы полным доступом к учётной записи, включая счёт выплат, и отзыв не спасал бы: он успел выдать себе второй. Ключ с любыми областями выдаётся из кабинета человеком.

Поля запроса

Поле	Тип	Что это
`name` обязательно	`string`	Имя для себя: «бот заливки», «сбор статистики». Без имени список ключей через полгода — список одинаковых строк.
`scopes` обязательно	`array`	Области действий. Отмечайте только нужные: утёкший ключ умеет ровно отмеченное.

Поля ответа

Поле	Тип	Что это
`key`	`string`	Сам ключ — в первый и последний раз.
`prefix`	`string`	Видимая часть для узнавания в списке.

Поводы отказа

Отказ по правилам приходит как {"error":"rejected","refusal":{"kind":"…"}} с кодом 409. Общие для всех путей отказы — в разделе правил.

Код	Что случилось и что делать
`key_no_name`	Ключу нужно имя: через полгода список безымянных ключей — список одинаковых строк.
`key_no_scopes`	Ключ без областей не умеет ничего. Отметьте нужные.
`key_too_many`	Живых ключей уже столько, сколько можно. Отзовите ненужные: сотня забытых ключей означает, что нужный не отозвать.
`key_scope_escalation`	Ключ не может выдать области, которых нет у него самого. Внутри отказа названы лишние. Ключ с любыми областями выдаётся из кабинета человеком.

Рядом в этом разделе

GET /api/v1/keys — Свои ключи доступа
DELETE /api/v1/keys/{id} — Отозвать ключ