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

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