Autentikasi

Semua permintaan API ke badges.ninja memerlukan autentikasi. Halaman ini menjelaskan cara mengautentikasi permintaan Anda.

URL Dasar

https://api.badges.ninja

Semua endpoint API relatif terhadap URL dasar ini.

Autentikasi Kunci API

Metode autentikasi utama adalah kunci API yang dilewatkan di tajuk X-Api-Key.

Mendapatkan Kunci API

Dari dasbor:

1. Masuk di badges.ninja.
2. Buka Kunci API di bilah sisi.
3. Klik Buat Kunci API.
4. Salin kunci (hanya ditampilkan sekali).

Dari API:

Kunci API juga dapat dikelola via API menggunakan token JWT Anda dari alur autentikasi Cognito. Lihat dasbor untuk pendekatan paling sederhana.

Menggunakan Kunci API Anda

Sertakan tajuk X-Api-Key di 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 melewatkan parameter sebagai string kueri
• Permintaan POST dan PUT mengirim 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"
  }
}

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

Respons Contoh

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

Batas Tarif

Permintaan API tunduk pada pembatasan tarif. Jika Anda melebihi batas, Anda menerima respons 429 Too Many Requests. Tunggu beberapa detik dan coba lagi.

Endpoint Publik

Beberapa endpoint tidak memerlukan autentikasi. Itu adalah endpoint verifikasi publik di bawah /certify-badge/ yang memungkinkan siapa saja memverifikasi kredensial lencana.