Ключи
Как выпустить API-ключ Флоктора, поставить предел трат на день или месяц, посмотреть расход по ключу и отозвать его при утечке.
Ключ — это то, чем ваша программа подтверждает, что запрос идёт от вашего аккаунта. Все ключи находятся в личном кабинете, на странице «API-ключи».
Как выпустить ключ
Нажмите «Создать ключ», задайте название и, если нужно, поставьте предел трат.
Название видно только вам и ни на что не влияет. Но когда ключей несколько, оно единственное, по чему их можно различить в списке и в статистике, поэтому называйте по месту использования: «ноутбук», «сервер сборки», «эксперименты».
Готовый ключ показывается один раз — в окне создания. Дальше в кабинете виден только его префикс. Мы не храним ключ в открытом виде и не можем показать его повторно: если он потерян, выпускайте новый, а старый отзывайте.
Ключ выглядит так: flk_ и дальше случайная строка. Копируйте целиком. Обрезанный ключ даёт ошибку 401, и выглядит она точно так же, как неверный ключ.
Как ограничить траты по ключу
У каждого ключа есть переключатель «Установить лимит». Включите его, укажите сумму в кредитах и выберите период:
- За всё время — предел на весь срок жизни ключа.
- В день, в неделю, в месяц — предел, который обновляется с началом нового периода.
Когда ключ потратит эту сумму, он перестаёт принимать запросы. Ответ будет 429 с кодом spend_limit_exceeded и заголовком Retry-After, где указано, через сколько секунд начнётся следующий период. Остальные ключи аккаунта продолжат работать.
Предел ограничивает ключ, а не создаёт отдельный кошелёк. Деньги списываются с общего баланса аккаунта, и если баланс кончится раньше предела, ключ остановится по балансу: 402, код insufficient_balance.
Предел и период меняются в настройках ключа в любой момент. Сам ключ при этом остаётся прежним, переписывать конфигурации на всех машинах не придётся.
Предел считается по факту списаний. При большом числе одновременных запросов их общая стоимость может немного превысить установленную сумму: к моменту, когда стоимость последнего посчитана, все они уже выполнены. Предел стоит воспринимать как страховку от аварийного расхода, а не как точную границу до копейки.
Где посмотреть расход
Под списком ключей показаны расход и количество запросов с разбивкой по ключам и графиком по часам или дням. Это самый быстрый способ понять, какая из ваших программ тратит больше всех и когда именно.
Как отозвать ключ
Отозванный ключ перестаёт работать немедленно и необратимо. Всё, что было на него настроено, потеряет доступ и начнёт получать 401.
Отзывайте ключ, если он мог попасть не туда: в чужие руки, в скриншот, в историю команд, в репозиторий. Восстановить отозванный ключ нельзя, вместо него выпускается новый.
Как хранить ключ
Ключ — это пароль. Три правила закрывают почти все способы его потерять:
- Держите ключ в переменной окружения или в файле настроек инструмента, а не в коде.
- Не коммитьте файлы с ключом. Если ключ всё же попал в git, отзовите его: история остаётся в клонах и форках, удалить её отовсюду невозможно.
- Заводите отдельный ключ на каждую машину и каждый сервис. Тогда при утечке достаточно отозвать один, а не переписывать все конфигурации сразу.