Kunci API

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

Membuat Kunci API

1. Buka halaman Kunci API dari bilah sisi.
2. Klik Buat Kunci API. Formulir sebaris terbuka:

3. Beri nama untuk kunci dan klik Buat. Kunci lengkap diungkapkan sekali pada spanduk hijau:

4. Salin kunci segera — hanya ditampilkan sekali. Jika hilang, Anda perlu membuat yang baru. Setelah Anda menutup spanduk, hanya awalan yang disimpan:

Cakupan Akses

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

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

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

Format Kunci

Kunci API menggunakan awalan bws_ diikuti oleh string heksadesimal 32 karakter:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Menggunakan Kunci API dalam Permintaan

Sertakan kunci API di tajuk X-Api-Key dari 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 tergantung pada paket Anda:

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

Menghapus Kunci

1. Buka halaman Kunci API.
2. Temukan kunci yang ingin Anda hapus.
3. Klik Hapus.
4. Konfirmasi penghapusan.

Setelah dihapus, kunci segera berhenti bekerja. Aplikasi apa pun yang menggunakan kunci itu akan menerima kesalahan autentikasi.