Pengesahan

Semua permintaan API kepada 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

Daripada papan pemuka:

1. Log masuk di badges.ninja.
2. Pergi ke Kunci API dalam bar sisi.
3. Klik Cipta Kunci API.
4. Salin kunci (ia hanya ditunjukkan sekali sahaja).

Daripada API:

Kunci API juga boleh diuruskan melalui API menggunakan token JWT anda daripada aliran pengesahan Cognito. Lihat papan pemuka untuk pendekatan 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 tindak balas mengembalikan JSON dengan Content-Type: application/json

Struktur Permintaan POST/PUT

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

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

Tindak Balas Contoh

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

Had Kadar

Permintaan API tertakluk kepada had kadar. Jika anda melebihi had, anda menerima tindak balas 429 Too Many Requests. Tunggu beberapa saat dan cuba semula.

Endpoint Awam

Sesetengah endpoint tidak memerlukan pengesahan. Itu adalah endpoint pengesahan awam di bawah /certify-badge/ yang membenarkan sesiapa sahaja mengesahkan kelayakan lencana.