Issuers API

Pārvaldiet nozīmju izsniedzējus — organizācijas vai personas, kas izsniedz nozīmes.

Visiem galapunktiem nepieciešama autentifikācija, izmantojot galveni X-Api-Key. Skatiet Autentifikācija.

Izveidot izsniedzēju

Izveidojiet jaunu nozīmju izsniedzēju.

POST /issuers

Parametri

Parametrs	Tips	Obligāts	Apraksts
name	string	Jā	Organizācijas nosaukums (vismaz 3 rakstzīmes)
url	string	Jā	Organizācijas tīmekļa vietne (jābūt derīgam HTTP/HTTPS URL)
email	string	Jā	Izsniedzēja kontakta e-pasts
logo	string	Nē	Base64 kodēts attēls (PNG vai JPG)
linkedinOrganizationId	string	Nē	Skaitliskais LinkedIn uzņēmuma lapas ID. Ja tas ir iestatīts, katrā šī izsniedzēja publiskajā apliecinājuma lapā tiek rādīta poga Add to LinkedIn Profile.

Piemērs

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

Atbilde

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

Piezīmes

• Tiek ieskaitīts jūsu plāna izsniedzēju ierobežojumā (Free: 2, Starter: 5, Pro: 10). Kvota netiek atskaitīta.
• Ja izsniedzēja e-pasts sakrīt ar jūsu konta e-pastu, izsniedzējs tiek verificēts automātiski.
• Ja e-pasts atšķiras, verifikācijas e-pasts tiek nosūtīts uz izsniedzēja e-pasta adresi.
• Pēc izsniedzēja konfigurēšanas izmantojiet Apliecinājumu API, lai sāktu izsniegt apliecinājumus šim izsniedzējam.

---

Uzskaitīt izsniedzējus

Iegūstiet visus jūsu izveidotos izsniedzējus.

GET /issuers

Piemērs

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

Atbilde

{
  "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 ir Unix laika atzīme milisekundēs. Ja izsniedzēju ir vairāk, nekā ietilpst vienā lapā, lapošanai papildus tiek atgriezts arī lastEvaluatedKey.

---

Pārbaudīt izsniedzēju

Verificējiet izsniedzēju, izmantojot uz tā e-pastu nosūtīto verifikācijas kodu.

POST /issuers/{issuerId}/verify

Parametri

Parametrs	Tips	Obligāts	Apraksts
issuerId	string	Jā	Izsniedzēja ID (ceļa parametrs)
code	string	Jā	Verifikācijas kods no e-pasta

Piemērs

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

Atbilde

Vienkārša virkne:

"issuer has been verified"

---

Dzēst izsniedzēju

Izdzēsiet izsniedzēju. Ar izsniedzēju nedrīkst būt saistītu nozīmju.

DELETE /issuers/{issuerId}

Piemērs

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

Atbilde

Vienkārša virkne:

"issuer has been deleted"

Kļūdas

• 400 — izsniedzējam joprojām ir saistītas nozīmes: issuer has {n} badge(s) linked — delete the badges first. Dzēšanu ierobežo tikai saistītās nozīmes — apliecinājumi to nebloķē.
• 404 — izsniedzējs nav atrasts

---

Atjaunināt izsniedzēju

Atjauniniet izsniedzēja laukus. Rediģēt var tikai neverificētus izsniedzējus — kad izsniedzējs ir verificēts, šis galapunkts atgriež 400 verified issuers cannot be edited, lai saglabātu apliecinājumu stabilitāti. Rediģējot izsniedzēju, tiek ģenerēts jauns verifikācijas kods: ja email sakrīt ar jūsu konta e-pastu, izsniedzējs tiek verificēts atkārtoti automātiski, pretējā gadījumā uz šo adresi tiek nosūtīts jauns verifikācijas e-pasts.

PUT /issuers/{issuerId}

Parametri

Parametrs	Tips	Obligāts	Apraksts
issuerId	string	Jā	Izsniedzēja ID (ceļa parametrs)
name	string	Nē	Jauns nosaukums
url	string	Nē	Jauns URL
email	string	Nē	Jauns e-pasts (nosūta jaunu verifikācijas e-pastu, ja vien tas nesakrīt ar jūsu konta e-pastu)
logo	string	Nē	Jauns Base64 kodēts logotips
linkedinOrganizationId	string	Nē	Jauns LinkedIn organizācijas ID (vai tukša virkne, lai to notīrītu)

Atbilde

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

Kļūdas

• 400 — verified issuers cannot be edited (izsniedzējs jau ir verificēts)
• 400 — not authorized (izsniedzējs pieder citam kontam)
• 404 — izsniedzējs nav atrasts