API Pengeluar

Urus pengeluar lencana — organisasi atau individu yang menganugerahkan lencana.

Semua endpoint memerlukan pengesahan melalui pengepala X-Api-Key. Lihat Pengesahan.

Cipta Pengeluar

Cipta pengeluar lencana baharu.

POST /issuers

Parameter

Parameter	Jenis	Diperlukan	Penerangan
name	string	Ya	Nama organisasi (minimum 3 aksara)
url	string	Ya	Laman web organisasi (mestilah URL HTTP/HTTPS yang sah)
email	string	Ya	E-mel hubungan untuk pengeluar
logo	string	Tidak	Imej berkod Base64 (PNG atau JPG)
linkedinOrganizationId	string	Tidak	ID berangka halaman syarikat LinkedIn. Apabila ditetapkan, setiap halaman anugerah awam daripada pengeluar ini menunjukkan butang Tambah ke Profil LinkedIn.

Contoh

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

Tindak Balas

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

Nota

• Dikira terhadap had pengeluar pelan anda (Free: 1, Starter: 5, Pro: tanpa had). Tiada potongan kuota.
• Jika e-mel pengeluar sepadan dengan e-mel akaun anda, pengeluar disahkan secara automatik.
• Jika e-mel berbeza, e-mel pengesahan dihantar ke e-mel pengeluar.

---

Senaraikan Pengeluar

Dapatkan semua pengeluar yang telah anda cipta.

GET /issuers

Contoh

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

Tindak Balas

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

---

Sahkan Pengeluar

Sahkan pengeluar menggunakan kod pengesahan yang dihantar ke e-melnya.

POST /issuers/{issuerId}/verify

Parameter

Parameter	Jenis	Diperlukan	Penerangan
issuerId	string	Ya	ID pengeluar (parameter laluan)
code	string	Ya	Kod pengesahan daripada e-mel

Contoh

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

Tindak Balas

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

---

Padam Pengeluar

Padam pengeluar. Pengeluar mestilah tidak mempunyai lencana.

DELETE /issuers/{issuerId}

Contoh

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

Tindak Balas

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

Ralat

• 400 — pengeluar mempunyai lencana atau anugerah dan tidak boleh dipadam (padam itu dahulu)
• 404 — pengeluar tidak ditemui

---

Kemas Kini Pengeluar

Kemas kini medan pengeluar yang belum disahkan. Setelah pengeluar disahkan, hanya logo dan linkedinOrganizationId kekal boleh disunting untuk mengekalkan kestabilan kelayakan.

PUT /issuers/{issuerId}

Parameter

Parameter	Jenis	Diperlukan	Penerangan
issuerId	string	Ya	ID pengeluar (parameter laluan)
name	string	Tidak	Nama baharu (hanya apabila belum disahkan)
url	string	Tidak	URL baharu (hanya apabila belum disahkan)
email	string	Tidak	E-mel baharu (hanya apabila belum disahkan — menghantar e-mel pengesahan baharu)
logo	string	Tidak	Logo berkod Base64 baharu
linkedinOrganizationId	string	Tidak	LinkedIn organization ID baharu (atau rentetan kosong untuk mengosongkan)

---

Putar Kod Pengesahan

Batalkan pautan pengesahan sebelumnya dan e-melkan yang baharu. Hanya sah ketika pengeluar masih belum disahkan.

POST /issuers/{issuerId}/rotate-code

Tindak Balas

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