Väljastajate API

Halda märkide väljastajaid — organisatsioone või isikuid, kes märke väljastavad.

Kõik otspunktid nõuavad autentimist päisega X-Api-Key. Vaata Autentimine.

Loo väljastaja

Loo uus märgi väljastaja.

POST /issuers

Parameetrid

Parameeter	Tüüp	Kohustuslik	Kirjeldus
name	string	Jah	Organisatsiooni nimi (vähemalt 3 märki)
url	string	Jah	Organisatsiooni veebisait (peab olema kehtiv HTTP/HTTPS URL)
email	string	Jah	Väljastaja kontakt-e-post
logo	string	Ei	Base64-kodeeritud pilt (PNG või JPG)
linkedinOrganizationId	string	Ei	LinkedIni ettevõtte lehe numbriline ID. Kui see on määratud, kuvab iga selle väljastaja avalik tunnistuse leht nuppu Add to LinkedIn Profile.

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": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com"
    }
  }'

Vastus

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Märkused

• Läheb arvesse sinu plaani väljastajate piiri hulka (Free: 2, Starter: 5, Pro: 10). Kvooti maha ei arvestata.
• Kui väljastaja e-post ühtib sinu konto e-postiga, kinnitatakse väljastaja automaatselt.
• Kui e-post on erinev, saadetakse väljastaja e-posti aadressile kinnituskiri.
• Pärast väljastaja seadistamist kasuta tunnistuste väljastamise alustamiseks selle väljastaja all Tunnistuste API-t.

---

Loetle väljastajad

Too kõik sinu loodud väljastajad.

GET /issuers

Näide

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

Vastus

{
  "items": [
    {
      "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
      "name": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com",
      "verified": true,
      "timestamp": 1736937000000
    }
  ]
}

timestamp on Unixi epohhi aeg millisekundites. Kui väljastajaid on rohkem, kui ühele lehele mahub, tagastatakse lehitsemiseks ka lastEvaluatedKey.

---

Kinnita väljastaja

Kinnita väljastaja tema e-posti saadetud kinnituskoodiga.

POST /issuers/{issuerId}/verify

Parameetrid

Parameeter	Tüüp	Kohustuslik	Kirjeldus
issuerId	string	Jah	Väljastaja ID (teeparameeter)
code	string	Jah	E-kirjas olev kinnituskood

Näide

curl -X POST https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/verify \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "code": "ABC123"
    }
  }'

Vastus

Paljas string:

"issuer has been verified"

---

Kustuta väljastaja

Kustuta väljastaja. Väljastajaga ei tohi olla seotud ühtegi märki.

DELETE /issuers/{issuerId}

Näide

curl -X DELETE https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Api-Key: bws_your_api_key_here"

Vastus

Paljas string:

"issuer has been deleted"

Vead

• 400 — väljastajaga on endiselt märke seotud: issuer has {n} badge(s) linked — delete the badges first. Kustutamist piiravad ainult seotud märgid — tunnistused seda ei takista.
• 404 — väljastajat ei leitud

---

Uuenda väljastajat

Uuenda väljastaja välju. Muuta saab ainult kinnitamata väljastajaid — kui väljastaja on kinnitatud, tagastab see otspunkt 400 verified issuers cannot be edited, et tunnistused püsiksid stabiilsed. Väljastaja muutmine genereerib uue kinnituskoodi: kui email ühtib sinu konto e-postiga, kinnitatakse väljastaja automaatselt uuesti, vastasel juhul saadetakse sellele aadressile uus kinnituskiri.

PUT /issuers/{issuerId}

Parameetrid

Parameeter	Tüüp	Kohustuslik	Kirjeldus
issuerId	string	Jah	Väljastaja ID (teeparameeter)
name	string	Ei	Uus nimi
url	string	Ei	Uus URL
email	string	Ei	Uus e-post (saadab uue kinnituskirja, kui see ei ühti sinu konto e-postiga)
logo	string	Ei	Uus base64-kodeeritud logo
linkedinOrganizationId	string	Ei	Uus LinkedIni organisatsiooni ID (või tühi string selle eemaldamiseks)

Vastus

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "updated": true
}

Vead

• 400 — verified issuers cannot be edited (väljastaja on juba kinnitatud)
• 400 — not authorized (väljastaja kuulub teisele kontole)
• 404 — väljastajat ei leitud