Автентифікація

Усі API-запити до badges.ninja потребують автентифікації. Ця сторінка пояснює, як її виконувати.

Базовий URL

https://api.badges.ninja

Усі ендпоінти API відносні цього базового URL.

Автентифікація за ключем API

Основний спосіб автентифікації — ключ API, переданий у заголовку X-Api-Key.

Отримання ключа API

З панелі керування:

1. Увійдіть на badges.ninja.
2. Перейдіть до API Keys у бічному меню.
3. Натисніть Create API Key.
4. Скопіюйте ключ (він показується лише один раз).

Через API:

Ключами API також можна керувати через API за допомогою вашого JWT-токена з потоку автентифікації Cognito. Найпростіший спосіб — через панель керування.

Використання ключа API

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

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

Формат ключа API

Ключі використовують префікс bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Формат запиту

• GET-запити передають параметри як query string
• POST і PUT-запити надсилають JSON-тіло з обʼєктом parameters
• Усі відповіді повертають JSON із Content-Type: application/json

Структура POST/PUT-запиту

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Приклад запиту

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Приклад відповіді

{
  "statusCode": 200,
  "info": {
    "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
  }
}

Обмеження частоти

API-запити підлягають обмеженню частоти. При перевищенні ліміту повертається відповідь 429 Too Many Requests. Зачекайте кілька секунд і спробуйте знову.

Публічні ендпоінти

Деякі ендпоінти не потребують автентифікації. Це публічні ендпоінти верифікації за префіксом /certify-badge/, що дозволяють будь-кому перевіряти посвідчення значків.