Issuers API

Tvarkykite ženklelių išdavėjus — organizacijas ar asmenis, kurie išduoda ženklelius.

Visiems galiniams taškams reikalingas autentifikavimas per antraštę X-Api-Key. Žr. Autentifikavimas.

Sukurti išdavėją

Sukurkite naują ženklelių išdavėją.

POST /issuers

Parametrai

Parametras	Tipas	Privalomas	Aprašymas
name	string	Taip	Organizacijos pavadinimas (mažiausiai 3 simboliai)
url	string	Taip	Organizacijos svetainė (turi būti teisingas HTTP/HTTPS URL)
email	string	Taip	Išdavėjo kontaktinis el. paštas
logo	string	Ne	Base64 koduotas vaizdas (PNG arba JPG)
linkedinOrganizationId	string	Ne	Skaitinis LinkedIn įmonės puslapio ID. Jį nustačius, kiekviename šio išdavėjo viešame pažymėjimo puslapyje rodomas mygtukas Add to LinkedIn Profile.

Pavyzdys

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

Atsakymas

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

Pastabos

• Įskaičiuojamas į jūsų plano išdavėjų limitą (Free: 2, Starter: 5, Pro: 10). Kvota nenuskaičiuojama.
• Jei išdavėjo el. paštas sutampa su jūsų paskyros el. paštu, išdavėjas patikrinamas automatiškai.
• Jei el. paštas skiriasi, patikrinimo laiškas išsiunčiamas išdavėjo el. pašto adresu.
• Sukonfigūravę išdavėją, naudokite Pažymėjimų API, kad pradėtumėte išduoti pažymėjimus tam išdavėjui.

---

Išvardyti išdavėjus

Gaukite visus jūsų sukurtus išdavėjus.

GET /issuers

Pavyzdys

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

Atsakymas

{
  "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 yra Unix epochos laikas milisekundėmis. Kai išdavėjų yra daugiau, nei telpa viename puslapyje, puslapiavimui papildomai grąžinamas lastEvaluatedKey.

---

Patvirtinti išdavėją

Patikrinkite išdavėją naudodami į jo el. paštą išsiųstą patikrinimo kodą.

POST /issuers/{issuerId}/verify

Parametrai

Parametras	Tipas	Privalomas	Aprašymas
issuerId	string	Taip	Išdavėjo ID (kelio parametras)
code	string	Taip	Patikrinimo kodas iš el. laiško

Pavyzdys

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

Atsakymas

Paprasta eilutė:

"issuer has been verified"

---

Ištrinti išdavėją

Ištrinkite išdavėją. Prie išdavėjo neturi būti susietų ženklelių.

DELETE /issuers/{issuerId}

Pavyzdys

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

Atsakymas

Paprasta eilutė:

"issuer has been deleted"

Klaidos

• 400 — prie išdavėjo vis dar yra susietų ženklelių: issuer has {n} badge(s) linked — delete the badges first. Ištrynimą riboja tik susieti ženkleliai — pažymėjimai jo neblokuoja.
• 404 — išdavėjas nerastas

---

Atnaujinti išdavėją

Atnaujinkite išdavėjo laukus. Redaguoti galima tik nepatikrintus išdavėjus — kai išdavėjas patikrintas, šis galinis taškas grąžina 400 verified issuers cannot be edited, kad pažymėjimai išliktų stabilūs. Redaguojant išdavėją sugeneruojamas naujas patikrinimo kodas: jei email sutampa su jūsų paskyros el. paštu, išdavėjas patikrinamas iš naujo automatiškai, kitu atveju į tą adresą išsiunčiamas naujas patikrinimo laiškas.

PUT /issuers/{issuerId}

Parametrai

Parametras	Tipas	Privalomas	Aprašymas
issuerId	string	Taip	Išdavėjo ID (kelio parametras)
name	string	Ne	Naujas pavadinimas
url	string	Ne	Naujas URL
email	string	Ne	Naujas el. paštas (išsiunčia naują patikrinimo laišką, nebent sutampa su jūsų paskyros el. paštu)
logo	string	Ne	Naujas Base64 koduotas logotipas
linkedinOrganizationId	string	Ne	Naujas LinkedIn organizacijos ID (arba tuščia eilutė, kad išvalytumėte)

Atsakymas

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

Klaidos

• 400 — verified issuers cannot be edited (išdavėjas jau patikrintas)
• 400 — not authorized (išdavėjas priklauso kitai paskyrai)
• 404 — išdavėjas nerastas