API Lencana

Kelola templat lencana — kredensial yang Anda berikan kepada penerima.

Semua endpoint memerlukan autentikasi via tajuk X-Api-Key. Lihat Autentikasi.

Buat Lencana

Buat lencana baru di bawah penerbit terverifikasi.

POST /badges

Parameter

Parameter	Tipe	Diperlukan	Deskripsi
name	string	Ya	Judul lencana
description	string	Ya	Apa yang diwakili lencana
criteria	string	Ya	Apa yang dilakukan penerima untuk mendapatkan lencana ini
image	string	Ya	Gambar berkode Base64 (PNG atau JPG)
issuerId	string	Ya	ID penerbit terverifikasi

Contoh

curl -X POST https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "JavaScript Fundamentals",
      "description": "Demonstrates proficiency in core JavaScript concepts",
      "criteria": "Completed the JavaScript Fundamentals course with a score of 80% or higher",
      "image": "data:image/png;base64,iVBORw0KGgo...",
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }'

Respons

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901"
  }
}

Catatan

• Penerbit harus diverifikasi sebelum membuat lencana.
• Gambar diunggah ke IPFS untuk penyimpanan permanen.

---

Daftar Lencana

Ambil semua lencana yang telah Anda buat.

GET /badges

Contoh

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

Respons

{
  "statusCode": 200,
  "info": {
    "badges": [
      {
        "id": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
        "name": "JavaScript Fundamentals",
        "description": "Demonstrates proficiency in core JavaScript concepts",
        "criteria": { "narrative": "Completed the JavaScript Fundamentals course..." },
        "image": "https://ipfs.ninja/ipfs/Qm...",
        "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
        "timestamp": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

Perbarui Lencana

Perbarui lencana yang ada. Hanya bidang yang Anda berikan yang diubah.

PUT /badges/{badgeId}

Parameter

Parameter	Tipe	Diperlukan	Deskripsi
badgeId	string	Ya	ID lencana (parameter jalur)
name	string	Tidak	Judul lencana baru
description	string	Tidak	Deskripsi baru
criteria	string	Tidak	Kriteria baru
image	string	Tidak	Gambar berkode Base64 baru

Contoh

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "name": "JavaScript Fundamentals v2",
      "description": "Updated description for the JS badge"
    }
  }'

Respons

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
    "updated": true
  }
}

---

Perbarui Teks Berbagi

Atur teks kustom yang ditampilkan saat penerima membagikan lencana ini di media sosial.

PUT /badges/{badgeId}/share-text

Parameter

Parameter	Tipe	Diperlukan	Deskripsi
badgeId	string	Ya	ID lencana (parameter jalur)
text	string	Ya	Teks berbagi (HTML tidak diizinkan)

Contoh

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901/share-text \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
    }
  }'

Respons

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

---

Hapus Lencana

Hapus lencana. Lencana tidak boleh memiliki penghargaan.

DELETE /badges/{badgeId}

Contoh

curl -X DELETE https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

Respons

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

Kesalahan

• 400 — lencana memiliki penghargaan dan tidak dapat dihapus
• 404 — lencana tidak ditemukan