Todennus

Kaikki API-pyynnöt badges.ninjalle vaativat todennuksen. Tämä sivu selittää, kuinka todennat pyyntösi.

Perus-URL

https://api.badges.ninja

Kaikki API-päätepisteet ovat suhteellisia tähän perus-URL-osoitteeseen.

API-avaintodennus

Ensisijainen todennustapa on API-avain, joka välitetään X-Api-Key-otsikossa.

API-avaimen hankkiminen

Hallintapaneelista:

1. Kirjaudu sisään osoitteessa badges.ninja.
2. Mene sivupalkissa kohtaan API-avaimet.
3. Napsauta Luo API-avain.
4. Kopioi avain (se näytetään vain kerran).

APIsta:

API-avaimia voidaan hallita myös APIn kautta käyttämällä JWT-tokenia Cognito-todennusvirrasta. Katso hallintapaneeli helpointa lähestymistapaa varten.

API-avaimesi käyttäminen

Sisällytä X-Api-Key-otsikko jokaiseen pyyntöön:

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

API-avaimen muoto

Avaimet käyttävät etuliitettä bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Pyynnön muoto

• GET-pyynnöt välittävät parametrit kyselystringeinä
• POST- ja PUT-pyynnöt lähettävät JSON-rungon parameters-objektilla
• Kaikki vastaukset palauttavat JSONin otsikolla Content-Type: application/json

POST/PUT-pyynnön rakenne

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

Esimerkkipyyntö

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

Esimerkkivastaus

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

Nopeusrajoitukset

API-pyynnöt ovat nopeusrajoituksen alaisia. Jos ylität rajan, saat 429 Too Many Requests -vastauksen. Odota muutama sekunti ja yritä uudelleen.

Julkiset päätepisteet

Jotkin päätepisteet eivät vaadi todennusta. Ne ovat julkiset varmistuspäätepisteet /certify-badge/-polun alla, joiden avulla kuka tahansa voi varmistaa merkkitunnisteet.