Autentifikacija

Svi API zahtjevi prema badges.ninja zahtijevaju autentifikaciju. Ova stranica objašnjava kako autentificirati svoje zahtjeve.

Osnovni URL

https://api.badges.ninja

Svi API endpointi relativni su u odnosu na ovaj osnovni URL.

Autentifikacija API ključem

Primarna metoda autentifikacije je API ključ proslijeđen u zaglavlju X-Api-Key.

Dobivanje API ključa

S nadzorne ploče:

1. Prijavite se na badges.ninja.
2. U bočnoj traci otvorite API Keys.
3. Kliknite Create API Key.
4. Kopirajte ključ (prikazuje se samo jednom).

Putem API-ja:

API ključevima može se upravljati i putem API-ja pomoću vašeg JWT tokena iz Cognito tijeka autentifikacije. Najjednostavniji pristup potražite na nadzornoj ploči.

Korištenje API ključa

Uključite zaglavlje X-Api-Key u svaki zahtjev:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

Format API ključa

Ključevi koriste prefiks bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Format zahtjeva

• GET zahtjevi prosljeđuju parametre kao query string
• POST i PUT zahtjevi šalju JSON tijelo s objektom parameters
• Svi odgovori vraćaju JSON sa zaglavljem Content-Type: application/json

Struktura POST/PUT zahtjeva

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Primjer zahtjeva

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"
    }
  }'

Primjer odgovora

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

Javni endpointi

Neki endpointi ne zahtijevaju autentifikaciju. To su javni endpointi za provjeru pod /certify-badge/ koji svakome omogućuju provjeru vjerodajnica bedževa.