Myöntäjät-API

Hallitse merkkimyöntäjiä — organisaatioita tai henkilöitä, jotka myöntävät merkkejä.

Kaikki päätepisteet vaativat todennuksen X-Api-Key-otsikon kautta. Katso Todennus.

Luo myöntäjä

Luo uusi merkkimyöntäjä.

POST /issuers

Parametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
name	string	Kyllä	Organisaation nimi (vähintään 3 merkkiä)
url	string	Kyllä	Organisaation verkkosivu (on oltava kelvollinen HTTP/HTTPS-URL)
email	string	Kyllä	Myöntäjän yhteyssähköposti
logo	string	Ei	Base64-koodattu kuva (PNG tai JPG)
linkedinOrganizationId	string	Ei	LinkedIn-yrityssivun numeerinen ID. Kun asetettu, jokainen tämän myöntäjän julkinen myöntösivu näyttää painikkeen Add to LinkedIn Profile.

Esimerkki

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

Vastaus

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

Huomautuksia

• Lasketaan tilauksesi myöntäjärajaa vastaan (Free: 1, Starter: 5, Pro: rajaton). Ei kiintiövähennystä.
• Jos myöntäjän sähköposti vastaa tilisi sähköpostia, myöntäjä varmennetaan automaattisesti.
• Jos sähköposti on erilainen, myöntäjän sähköpostiin lähetetään varmistussähköposti.

---

Listaa myöntäjät

Hae kaikki luomasi myöntäjät.

GET /issuers

Esimerkki

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

Vastaus

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

---

Varmenna myöntäjä

Varmenna myöntäjä käyttämällä sen sähköpostiin lähetettyä varmistuskoodia.

POST /issuers/{issuerId}/verify

Parametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
issuerId	string	Kyllä	Myöntäjän ID (polun parametri)
code	string	Kyllä	Sähköpostin varmistuskoodi

Esimerkki

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

Vastaus

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

---

Poista myöntäjä

Poista myöntäjä. Myöntäjällä ei saa olla merkkejä.

DELETE /issuers/{issuerId}

Esimerkki

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

Vastaus

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

Virheet

• 400 — myöntäjällä on merkkejä tai myöntöjä, eikä sitä voi poistaa (poista ne ensin)
• 404 — myöntäjää ei löydy

---

Päivitä myöntäjä

Päivitä varmentamattoman myöntäjän kentät. Kun myöntäjä on varmennettu, vain logo ja linkedinOrganizationId pysyvät muokattavissa tunnistevakauden säilyttämiseksi.

PUT /issuers/{issuerId}

Parametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
issuerId	string	Kyllä	Myöntäjän ID (polun parametri)
name	string	Ei	Uusi nimi (vain kun varmentamaton)
url	string	Ei	Uusi URL (vain kun varmentamaton)
email	string	Ei	Uusi sähköposti (vain kun varmentamaton — lähettää uuden varmistussähköpostin)
logo	string	Ei	Uusi base64-koodattu logo
linkedinOrganizationId	string	Ei	Uusi LinkedIn-organisaation ID (tai tyhjä merkkijono tyhjentämiseksi)

---

Kierrätä varmistuskoodi

Mitätöi edellinen varmistuslinkki ja lähetä sähköpostitse uusi. Voimassa vain niin kauan kuin myöntäjä on edelleen varmentamaton.

POST /issuers/{issuerId}/rotate-code

Vastaus

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