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

Сви 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/ које омогућавају било коме да верификује акредитиве значки.