Kunci API

Kunci API membolehkan anda mengakses REST API badges.ninja secara berprogram. Gunakannya untuk mengautomasikan penciptaan, pengeluaran dan pengurusan lencana daripada aplikasi anda sendiri.

Mencipta Kunci API

1. Buka halaman Kunci API daripada bar sisi.
2. Klik Cipta Kunci API. Borang sebaris dibuka:

3. Berikan nama kepada kunci dan klik Cipta. Kunci penuh didedahkan sekali sahaja pada sepanduk hijau:

4. Salin kunci dengan segera — ia hanya ditunjukkan sekali sahaja. Jika anda kehilangannya, anda perlu mencipta yang baharu. Selepas anda menutup sepanduk, hanya awalan disimpan:

Skop Akses

Apabila anda mencipta kunci, anda boleh menjadikannya baca sahaja atau membiarkannya akses penuh:

Skop	Membenarkan
Akses penuh (lalai)	Baca dan tulis — senaraikan data dan cipta, keluarkan, kemas kini atau padam.
Baca sahaja	Permintaan GET yang selamat sahaja. Sebarang permintaan yang mengubah (POST, PUT, PATCH, DELETE) ditolak dengan 403 Forbidden.

Gunakan kunci baca sahaja untuk integrasi yang hanya perlu membaca data anda (pelaporan, papan pemuka, sandaran) supaya kunci yang bocor tidak boleh mengubah apa-apa. Tandakan Read-only key dalam borang cipta; kunci baca sahaja memaparkan lencana Read-only dalam senarai. Kunci yang dicipta sebelum skop wujud mengekalkan akses penuh.

Format Kunci

Kunci API menggunakan awalan bws_ diikuti dengan rentetan heksadesimal 32 aksara:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Menggunakan Kunci API dalam Permintaan

Sertakan kunci API dalam pengepala X-Api-Key bagi setiap permintaan API:

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

Lihat halaman Pengesahan untuk butiran penuh mengenai pengesahan API.

Had Kunci Bagi Setiap Pelan

Bilangan kunci API yang boleh anda cipta bergantung kepada pelan anda:

Pelan	Had Kunci API
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Memadam Kunci

1. Buka halaman Kunci API.
2. Cari kunci yang ingin anda padam.
3. Klik Padam.
4. Sahkan pemadaman.

Setelah dipadam, kunci segera berhenti berfungsi. Mana-mana aplikasi yang menggunakan kunci itu akan menerima ralat pengesahan.