Kunci API

Kunci API memungkinkan Anda mengakses REST API badges.ninja secara terprogram. Gunakan kunci API untuk mengotomatiskan pembuatan, penerbitan, dan pengelolaan lencana dari aplikasi Anda sendiri.

Membuat Kunci API

1. Buka halaman API Keys dari bilah samping.
2. Klik Create API Key. Formulir inline akan terbuka:

3. Beri nama pada kunci lalu klik Create. Kunci lengkap ditampilkan satu kali pada banner hijau:

4. Salin kunci segera — kunci lengkap hanya ditampilkan satu kali. Jika hilang, Anda harus membuat kunci baru. Setelah Anda menutup banner, dasbor hanya menampilkan awalan kunci (misalnya bws_a1b2c3d4...); kunci lengkap tetap tersimpan di sisi server untuk mengautentikasi permintaan Anda:

Setiap baris juga menampilkan kapan kunci dibuat dan, setelah kunci digunakan, stempel waktu last used agar Anda dapat mengenali kunci yang sudah lama tidak dipakai.

Cakupan Akses

Saat membuat kunci, Anda dapat menjadikannya hanya-baca atau membiarkannya berakses penuh:

Cakupan	Mengizinkan
Akses penuh (default)	Baca dan tulis — melihat data serta membuat, menerbitkan, memperbarui, atau menghapus.
Hanya-baca	Hanya permintaan GET yang aman. Setiap permintaan yang mengubah data (POST, PUT, PATCH, DELETE) ditolak dengan 403 Forbidden.

Gunakan kunci hanya-baca untuk integrasi yang hanya perlu membaca data Anda (pelaporan, dasbor, pencadangan) sehingga kunci yang bocor tidak dapat mengubah apa pun. Centang Read-only key pada formulir pembuatan; kunci hanya-baca menampilkan lencana Read-only di daftar. Kunci yang dibuat sebelum cakupan ada tetap berakses penuh.

Format Kunci

Kunci API menggunakan awalan bws_ diikuti string heksadesimal 32 karakter:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Menggunakan Kunci API dalam Permintaan

Sertakan kunci API pada header X-Api-Key di setiap permintaan API:

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

Lihat halaman Autentikasi untuk detail lengkap tentang autentikasi API.

Batas Kunci per Paket

Jumlah kunci API yang dapat Anda buat bergantung pada paket Anda:

Paket	Batas Kunci API
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Masa Berlaku Kunci

Setiap kunci API kedaluwarsa satu tahun setelah dibuat. Setelah kedaluwarsa, kunci tidak lagi mengautentikasi permintaan, persis seperti jika kunci tersebut dihapus. Buat kunci baru sebelum kunci lama berakhir agar tidak terjadi gangguan.

Menghapus Kunci

1. Buka halaman API Keys.
2. Temukan kunci yang ingin Anda hapus.
3. Klik Delete.
4. Konfirmasikan penghapusan.

Setelah dihapus, kunci langsung berhenti berfungsi. Aplikasi apa pun yang menggunakan kunci tersebut akan menerima kesalahan autentikasi.