Autentimine

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

Baas-URL

https://api.badges.ninja

Kõik API otspunktid on selle baas-URL-i suhtes.

API võtmega autentimine

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

API võtme hankimine

Töölaualt:

1. Logi sisse aadressil badges.ninja.
2. Ava külgribal API Keys.
3. Klõpsa Create API Key.
4. Kopeeri võti (seda näidatakse ainult üks kord).

API kaudu:

API võtmeid saab hallata ka API kaudu, kasutades Cognito autentimisvoost saadud JWT tokenit. Lihtsaima lahenduse leiad töölaualt.

API võtme kasutamine

Lisa päis X-Api-Key igale päringule:

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

API võtme vorming

Võtmed kasutavad eesliidet bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Päringu vorming

• GET-päringud edastavad parameetrid päringustringina
• POST- ja PUT-päringud saadavad JSON-keha, mis sisaldab objekti 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"
  }
}

Päringu näide

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

Vastuse näide

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

Avalikud otspunktid

Mõned otspunktid ei nõua autentimist. Need on avalikud kinnitamise otspunktid aadressi /certify-badge/ all, mis lubavad igaühel märgitõendeid kinnitada.