Autentimine

Kõik API-päringud badges.ninja-le nõuavad autentimist. See leht selgitab, kuidas oma päringuid autentida.

Põhi-URL

https://api.badges.ninja

Kõik API-otspunktid on selle põhi-URL-i suhtes suhtelised.

API-võtmega autentimine

Peamine autentimisviis on API-võti, mida edastatakse päises X-Api-Key.

API-võtme hankimine

Töölaualt:

1. Logi sisse aadressil badges.ninja.
2. Mine küljemenüüst API-võtmed.
3. Klõpsa Loo API-võti.
4. Kopeeri võti (see kuvatakse ainult üks kord).

API kaudu:

API-võtmeid saab hallata ka API kaudu, kasutades Cognito autentimisvoolu JWT-tokenit. Lihtsaima lähenemisviisi jaoks vaata töölauda.

API-võtme kasutamine

Lisa iga päringu päisesse X-Api-Key:

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

API-võtme vorming

Võtmed kasutavad bws_ prefiksit:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Päringu vorming

• GET päringud edastavad parameetrid päringustringidena
• POST ja PUT päringud saadavad JSON-keha objektiga parameters
• Kõik vastused tagastavad JSON-i päisega Content-Type: application/json

POST/PUT päringu struktuur

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

Näide päring

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

Näide vastus

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

Kiirus­piirangud

API-päringud on allutatud kiiruspiirangutele. Kui ületad piirangu, saad vastuse 429 Too Many Requests. Oota mõni sekund ja proovi uuesti.

Avalikud otspunktid

Mõned otspunktid ei vaja autentimist. Need on avalikud kontrolli otspunktid aadressil /certify-badge/, mis võimaldavad igaühel kontrollida märgitõendeid.