Pengesahan

Semua permintaan API ke badges.ninja memerlukan pengesahan. Halaman ini menerangkan cara mengesahkan permintaan anda.

URL Asas

https://api.badges.ninja

Semua endpoint API adalah relatif kepada URL asas ini.

Pengesahan Kunci API

Kaedah pengesahan utama ialah kunci API yang dihantar dalam pengepala X-Api-Key.

Mendapatkan Kunci API

Dari papan pemuka:

1. Log masuk di badges.ninja.
2. Pergi ke API Keys dalam bar sisi.
3. Klik Create API Key.
4. Salin kunci tersebut (ia hanya dipaparkan sekali).

Dari API:

Kunci API juga boleh diurus melalui API menggunakan token JWT anda daripada aliran pengesahan Cognito. Lihat papan pemuka untuk cara yang paling mudah.

Menggunakan Kunci API Anda

Sertakan pengepala X-Api-Key dalam setiap permintaan:

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

Format Kunci API

Kunci menggunakan awalan bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Format Permintaan

• Permintaan GET menghantar parameter sebagai rentetan pertanyaan
• Permintaan POST dan PUT menghantar badan JSON dengan objek parameters
• Semua respons mengembalikan JSON dengan Content-Type: application/json

Struktur Permintaan POST/PUT

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Contoh Permintaan

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": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Contoh Respons

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
}

Endpoint Awam

Sesetengah endpoint tidak memerlukan pengesahan. Ini ialah endpoint pengesahan awam di bawah /certify-badge/ yang membolehkan sesiapa sahaja mengesahkan kelayakan lencana.