Аутентификация

Все запросы к 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/, позволяющие любому человеку проверить удостоверения значков.