Удостоверяване

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