Issuers API

Halda märkide väljastajaid — organisatsioonid või üksikisikud, kes annavad märke.

Kõik otspunktid nõuavad autentimist päise X-Api-Key kaudu. Vt Autentimine.

Loo väljastaja

Loo uus märkide väljastaja.

POST /issuers

Parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
name	string	Jah	Organisatsiooni nimi (vähemalt 3 tähemä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	Numbriline LinkedIn-i ettevõtte lehe ID. Kui seatud, näitab iga selle väljastaja avalik autasu 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

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

Märkused

• Loetakse sinu plaani väljastajate piiri vastu (Free: 1, Starter: 5, Pro: piiramatu). Kvoodi mahaarvamist pole.
• Kui väljastaja e-post ühtib sinu konto e-postiga, kinnitatakse väljastaja automaatselt.
• Kui e-post on erinev, saadetakse kinnituskiri väljastaja e-postile.

---

Loenda väljastajad

Hangi 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

{
  "statusCode": 200,
  "info": {
    "issuers": [
      {
        "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": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

Kinnita väljastaja

Kinnita väljastaja tema e-postile saadetud kinnituskoodi abil.

POST /issuers/{issuerId}/verify

Parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
issuerId	string	Jah	Väljastaja ID (tee-parameeter)
code	string	Jah	E-kirjast pärinev 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

{
  "statusCode": 200,
  "info": {
    "verified": true
  }
}

---

Kustuta väljastaja

Kustuta väljastaja. Väljastajal ei tohi olla märke.

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

{
  "statusCode": 200,
  "info": {
    "deleted": true
  }
}

Vead

• 400 — väljastajal on märke või autasusid ja seda ei saa kustutada (kustuta need esmalt)
• 404 — väljastajat ei leitud

---

Uuenda väljastajat

Uuenda kinnitamata väljastaja välju. Kui väljastaja on kinnitatud, jäävad muudetavaks ainult logo ja linkedinOrganizationId, et säilitada tõendi stabiilsus.

PUT /issuers/{issuerId}

Parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
issuerId	string	Jah	Väljastaja ID (tee-parameeter)
name	string	Ei	Uus nimi (ainult kinnitamata olekus)
url	string	Ei	Uus URL (ainult kinnitamata olekus)
email	string	Ei	Uus e-post (ainult kinnitamata olekus — saadab värske kinnituskirja)
logo	string	Ei	Uus base64-kodeeritud logo
linkedinOrganizationId	string	Ei	Uus LinkedIn-i organisatsiooni ID (või tühi string puhastamiseks)

---

Kinnituskoodi uuendamine

Tühista eelmine kinnituslink ja saada värske. Kehtib ainult siis, kui väljastaja on veel kinnitamata.

POST /issuers/{issuerId}/rotate-code

Vastus

{
  "statusCode": 200,
  "info": {
    "sent": true
  }
}