Issuers API

Upravljajte izdajatelje značk — organizacije ali posameznike, ki podeljujejo značke.

Vsi endpointi zahtevajo avtentikacijo prek glave X-Api-Key. Glej Avtentikacija.

Ustvari izdajatelja

Ustvarite novega izdajatelja značk.

POST /issuers

Parametri

Parameter	Tip	Obvezno	Opis
name	string	Da	Ime organizacije (najmanj 3 znaki)
url	string	Da	Spletna stran organizacije (mora biti veljaven HTTP/HTTPS URL)
email	string	Da	Kontaktni e-poštni naslov izdajatelja
logo	string	Ne	Slika, kodirana v Base64 (PNG ali JPG)
linkedinOrganizationId	string	Ne	Številčni ID firme na LinkedIn. Ko je nastavljen, vsaka javna stran podelitve od tega izdajatelja prikazuje gumb Add to LinkedIn Profile.

Primer

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

Odgovor

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

Opombe

• Šteje se proti omejitvi izdajateljev vašega paketa (Free: 1, Starter: 5, Pro: neomejeno). Brez odštevanja kvote.
• Če se e-pošta izdajatelja ujema z e-pošto vašega računa, se izdajatelj samodejno preveri.
• Če je e-pošta drugačna, se na e-pošto izdajatelja pošlje sporočilo za preverjanje.

---

Naštej izdajatelje

Pridobite vse izdajatelje, ki ste jih ustvarili.

GET /issuers

Primer

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

Odgovor

{
  "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"
      }
    ]
  }
}

---

Preveri izdajatelja

Preverite izdajatelja s kodo za preverjanje, poslano na njegov e-poštni naslov.

POST /issuers/{issuerId}/verify

Parametri

Parameter	Tip	Obvezno	Opis
issuerId	string	Da	ID izdajatelja (parameter poti)
code	string	Da	Koda za preverjanje iz e-pošte

Primer

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

Odgovor

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

---

Izbriši izdajatelja

Izbrišite izdajatelja. Izdajatelj ne sme imeti značk.

DELETE /issuers/{issuerId}

Primer

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

Odgovor

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

Napake

• 400 — izdajatelj ima značke ali podelitve in ga ni mogoče izbrisati (najprej izbrišite te)
• 404 — izdajatelj ni najden

---

Posodobi izdajatelja

Posodobite polja nepreverjenega izdajatelja. Ko je izdajatelj preveren, ostaneta uredljiva le logo in linkedinOrganizationId, da se ohrani stabilnost spričevala.

PUT /issuers/{issuerId}

Parametri

Parameter	Tip	Obvezno	Opis
issuerId	string	Da	ID izdajatelja (parameter poti)
name	string	Ne	Novo ime (le ko je nepreveren)
url	string	Ne	Nov URL (le ko je nepreveren)
email	string	Ne	Nova e-pošta (le ko je nepreveren — pošlje novo sporočilo za preverjanje)
logo	string	Ne	Nov logotip, kodiran v Base64
linkedinOrganizationId	string	Ne	Nov LinkedIn organization ID (ali prazen niz za izbris)

---

Rotiraj kodo za preverjanje

Razveljavite prejšnjo povezavo za preverjanje in pošljite novo po e-pošti. Veljavno le, dokler je izdajatelj še nepreveren.

POST /issuers/{issuerId}/rotate-code

Odgovor

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