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 su relativni u odnosu na ovaj osnovni URL.

Autentifikacija API ključem

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

Dohvaćanje API ključa

S nadzorne ploče:

1. Prijavite se na badges.ninja.
2. U bočnoj traci idite na API ključevi.
3. Kliknite Stvori API ključ.
4. Kopirajte ključ (prikazuje se samo jednom).

Iz API-ja:

API ključevima je također moguće upravljati preko API-ja korištenjem vašeg JWT tokena iz toka autentifikacije Cognito. Najjednostavniji pristup nalazi se u nadzornoj ploči.

Korištenje vašeg API ključa

U svaki zahtjev uključite zaglavlje X-Api-Key:

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 upitne nizove
• POST i PUT zahtjevi šalju JSON tijelo s objektom parameters
• Svi odgovori vraćaju JSON s Content-Type: application/json

Struktura zahtjeva POST/PUT

{
  "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

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

Ograničenja brzine

API zahtjevi podliježu ograničavanju brzine. Ako prekoračite ograničenje, primate odgovor 429 Too Many Requests. Pričekajte nekoliko sekundi i pokušajte ponovno.

Javni endpointi

Neki endpointi ne zahtijevaju autentifikaciju. To su javni endpointi za provjeru pod /certify-badge/ koji omogućuju bilo kome da provjeri vjerodajnice bedževa.