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

Усі 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-запити передають параметри в рядку запиту
• 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"
    }
  }'

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

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

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

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