Skip to content

Kunci API

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

Kunci API — keadaan kosong

Mencipta Kunci API

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

Cipta kunci — borang nama

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

Kunci yang baru dicipta didedahkan sekali sahaja

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

Senarai kunci menunjukkan awalan bertopeng

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:

bash
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:

PelanHad Kunci API
Free1
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.

Pengesahan padam kunci — pembatalan adalah serta-merta

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

badges.ninja Documentation