Ключи API
Создать ключ API
Заголовок раздела «Создать ключ API»POST /api/v1/api-keysСоздает новый ключ API для аутентифицированного пользователя.
Тело запроса
Заголовок раздела «Тело запроса»{ "name": "My integration"}| Поле | Обязательно | Описание |
|---|---|---|
name | Да | Отображаемое имя для ключа (1–100 символов) |
{ "data": { "id": "key_uuid", "name": "My integration", "prefix": "rm_abc123", "key": "rm_abc123def456...", "created_at": "2025-09-19T15:00:00.000Z" }}Список ключей API
Заголовок раздела «Список ключей API»GET /api/v1/api-keysВозвращает все ключи API для аутентифицированного пользователя. Полное значение ключа никогда не возвращается после создания.
{ "data": [ { "id": "key_uuid", "name": "My integration", "prefix": "rm_abc123", "created_at": "2025-09-19T15:00:00.000Z", "last_used_at": "2025-09-20T10:30:00.000Z", "is_revoked": false } ]}Отзыв ключа API
Заголовок раздела «Отзыв ключа API»DELETE /api/v1/api-keys/:idОкончательно отзывает ключ API. Запросы, использующие этот ключ, немедленно завершатся с ошибкой INVALID_API_KEY.
{ "data": { "success": true }}Коды ошибок
Заголовок раздела «Коды ошибок»| Код | Статус HTTP | Значение |
|---|---|---|
API_KEY_NOT_FOUND | 404 | Ключ не существует или принадлежит другому пользователю |
ALREADY_REVOKED | 400 | Ключ уже был отозван |