Autentifikācija

Visiem API pieprasījumiem uz badges.ninja nepieciešama autentifikācija. Šajā lapā paskaidrots, kā autentificēt savus pieprasījumus.

Pamata URL

https://api.badges.ninja

Visi API galapunkti norādīti attiecībā pret šo pamata URL.

Autentifikācija ar API atslēgu

Galvenā autentifikācijas metode ir API atslēga, kas tiek nodota galvenē X-Api-Key.

API atslēgas iegūšana

No informācijas paneļa:

1. Pierakstieties vietnē badges.ninja.
2. Sānjoslā atveriet API atslēgas.
3. Noklikšķiniet uz Izveidot API atslēgu.
4. Nokopējiet atslēgu (tā tiek parādīta tikai vienu reizi).

Izmantojot API:

API atslēgas var pārvaldīt arī ar API, izmantojot JWT tokenu no Cognito autentifikācijas plūsmas. Vienkāršākais veids ir izmantot informācijas paneli.

API atslēgas izmantošana

Iekļaujiet galveni X-Api-Key katrā pieprasījumā:

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

API atslēgas formāts

Atslēgām ir prefikss bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Pieprasījuma formāts

• GET pieprasījumi nodod parametrus vaicājuma virknē
• POST un PUT pieprasījumi sūta JSON pamatteksta saturu ar objektu parameters
• Visas atbildes atgriež JSON ar Content-Type: application/json

POST/PUT pieprasījuma struktūra

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

Pieprasījuma piemērs

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

Atbildes piemērs

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

Publiskie galapunkti

Dažiem galapunktiem autentifikācija nav nepieciešama. Tie ir publiskie verifikācijas galapunkti zem /certify-badge/, kas ļauj ikvienam veikt nozīmju apliecinājumu verifikāciju.