Todennus

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

Perus-URL

https://api.badges.ninja

Kaikki API:n päätepisteet ovat suhteessa tähän perus-URL:iin.

Todennus API-avaimella

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. Siirry sivupalkissa kohtaan API Keys.
3. Napsauta Create API Key.
4. Kopioi avain (se näytetään vain kerran).

API:n kautta:

API-avaimia voi hallita myös API:n kautta käyttämällä Cognito-todennuksesta saatua JWT-tokenia. Yksinkertaisin tapa on käyttää hallintapaneelia.

API-avaimen käyttö

Lisää 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 kyselymerkkijonona
• POST- ja PUT-pyynnöt lähettävät JSON-rungon, jossa on parameters-objekti
• Kaikki vastaukset palauttavat JSONia 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

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

Julkiset päätepisteet

Jotkin päätepisteet eivät vaadi todennusta. Nämä ovat /certify-badge/-polun alla olevat julkiset varmennuspäätepisteet, joiden avulla kuka tahansa voi varmentaa merkkitodistuksia.