Ключи API

Ключи API позволяют программно обращаться к REST API badges.ninja. Используйте их для автоматизации создания, выдачи и управления значками из собственных приложений.

Создание ключа API

1. Откройте страницу API Keys в боковом меню.
2. Нажмите Create API Key. Откроется встроенная форма:

3. Задайте ключу имя и нажмите Create. Полный ключ отображается один раз на зелёном баннере:

4. Сразу скопируйте ключ — он показывается только один раз. Если вы его потеряете, придётся создавать новый. После закрытия баннера сохраняется только префикс:

Области доступа

При создании ключа вы можете сделать его только для чтения или оставить с полным доступом:

Область доступа	Разрешает
Полный доступ (по умолчанию)	Чтение и запись — просмотр данных и создание, выдача, обновление или удаление.
Только чтение	Только безопасные запросы GET. Любой изменяющий запрос (POST, PUT, PATCH, DELETE) отклоняется с 403 Forbidden.

Используйте ключ только для чтения для интеграций, которым нужно только читать ваши данные (отчёты, дашборды, резервные копии), чтобы утёкший ключ ничего не мог изменить. Отметьте Read-only key в форме создания; ключи только для чтения показывают значок Read-only в списке. Ключи, созданные до появления областей доступа, сохраняют полный доступ.

Формат ключа

Ключи API используют префикс bws_, за которым следует 32-символьная hex-строка:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Использование ключей API в запросах

Добавляйте ключ API в заголовок X-Api-Key каждого API-запроса:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

Полные сведения об аутентификации API — на странице Аутентификация.

Лимиты ключей по тарифу

Количество ключей API, которые можно создать, зависит от тарифа:

Тариф	Лимит ключей API
Free	1
Starter ($9/мес)	5
Pro ($29/мес)	20

Удаление ключа

1. Откройте страницу API Keys.
2. Найдите ключ, который хотите удалить.
3. Нажмите Delete.
4. Подтвердите удаление.

После удаления ключ немедленно перестаёт работать. Все приложения, использующие его, будут получать ошибки аутентификации.