Autentifikācija

Visi API pieprasījumi uz badges.ninja prasa autentifikāciju. Šī lapa skaidro, kā autentificēt savus pieprasījumus.

Pamata URL

https://api.badges.ninja

Visi API galapunkti ir relatīvi pret šo pamata URL.

API atslēgu autentifikācija

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. Pieteikties vietnē badges.ninja.
2. Sānjoslā dodieties uz API atslēgas.
3. Noklikšķiniet uz Izveidot API atslēgu.
4. Nokopējiet atslēgu (tā tiek parādīta tikai vienu reizi).

No API:

API atslēgas var arī pārvaldīt caur API, izmantojot savu JWT tokenu no Cognito autentifikācijas plūsmas. Vienkāršākajai pieejai skatiet informācijas paneli.

Jūsu 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ēgas izmanto bws_ prefiksu:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Pieprasījuma formāts

• GET pieprasījumi nodod parametrus kā vaicājuma virknes
• POST un PUT pieprasījumi sūta JSON pamattekstu 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

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

Ātruma ierobežojumi

API pieprasījumiem tiek piemēroti ātruma ierobežojumi. Ja pārsniedzat ierobežojumu, saņemsiet atbildi 429 Too Many Requests. Pagaidiet dažas sekundes un mēģiniet vēlreiz.

Publiskie galapunkti

Daži galapunkti neprasa autentifikāciju. Tie ir publiskie pārbaudes galapunkti zem /certify-badge/, kas ļauj ikvienam pārbaudīt nozīmju apliecinājumus.