Skip to content

Ключі API

Ключі API дозволяють програмно звертатися до REST API badges.ninja. Використовуйте їх для автоматизації створення, видачі та управління значками з власних застосунків.

Ключі API — порожній список

Створення ключа API

  1. Відкрийте сторінку API Keys у бічному меню.
  2. Натисніть Create API Key. Відкриється вбудована форма:

Створення ключа — форма імені

  1. Дайте ключу назву та натисніть Create. Повний ключ відображається один раз на зеленому банері:

Щойно створений ключ показується один раз

  1. Одразу скопіюйте ключ — він показується лише один раз. Якщо втратите, доведеться створити новий. Після закриття банера зберігається лише префікс:

Список ключів із замаскованим префіксом

Формат ключа

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Використання ключів API у запитах

Додавайте ключ API до заголовка X-Api-Key у кожному API-запиті:

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

Повні відомості про автентифікацію API — на сторінці Автентифікація.

Ліміти ключів за тарифом

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

ТарифЛіміт ключів API
Free1
Starter ($9/міс)5
Pro ($29/міс)20

Видалення ключа

  1. Відкрийте сторінку API Keys.
  2. Знайдіть ключ, який хочете видалити.
  3. Натисніть Delete.
  4. Підтвердіть видалення.

Підтвердження видалення ключа — відкликання миттєве

Після видалення ключ негайно припиняє працювати. Усі застосунки, що його використовують, отримуватимуть помилки автентифікації.

badges.ninja Documentation