Ключи и права
Ключ в заголовке, три уровня прав, свой лимит знаков, адреса IP.
Ключ
Ключ создаётся в кабинете: Аккаунт → API → Новый ключ. Он показывается один раз — сохраните его сразу. Мы храним только отпечаток ключа и не можем показать его снова; потеряли — отзовите и создайте новый.
Передавайте ключ в заголовке каждого запроса:
x-api-key: gk_live_…
Можно и так: Authorization: Bearer gk_live_…. Ключ — как пароль: не кладите его в код страницы, приложения для телефона
или в открытый репозиторий; держите на своём сервере.
Кому доступен
- Ключ можно создать, если вы хоть раз купили пакет «Студия».
- API работает, пока на балансе есть знаки. Баланс кончился — каждый запрос отвечает
402. Работает толькоGET /api/me, чтобы ваш сервер видел, что случилось.
Права ключа
| Права | Что можно |
|---|---|
| Только чтение | Все запросы GET: книги, главы, герои, голоса, задачи, файлы. Ничего не меняется и не тратится. |
| Озвучка | Чтение + загрузить книгу, книга из текста, цена, озвучить главу, проверить на слух, послушать строку, другой дубль, /tts, собрать файл, отменить задачу. |
| Всё | Всё, что можно в кабинете с книгами: переименовать и удалить книгу, голоса героев, текст строк, словарь ударений, циклы. |
Никогда через ключ: деньги и оплата, аккаунт и пароль, сами ключи, поддержка, уведомления кабинета, скидка автора,
администрирование. Такой запрос отвечает 403.
Ограничения ключа
- Свой лимит знаков (необязательно): ключ тратит не больше этого числа знаков с баланса. Лимит проверяется перед каждым запросом — последняя задача может немного его перешагнуть.
- Адреса IP: ключ работает только с ваших серверов — адрес или сеть, например
203.0.113.0/24. - 120 запросов в минуту на ключ. Больше — ответ
429, подождите и повторите.
Каждая задача и каждое списание помнят, каким ключом сделаны: это видно в кабинете и в GET /api/me (key.used).