Mga API Key

Ang mga API key ay nagpapahintulot sa inyo na ma-access ang badges.ninja REST API programmatically. Gamitin ang mga ito para i-automate ang paggawa, pag-isyu, at pamamahala ng badge mula sa inyong sariling mga aplikasyon.

Paggawa ng API Key

1. Buksan ang pahina ng API Keys mula sa sidebar.
2. I-click ang Create API Key. Magbubukas ang inline form:

3. Bigyan ng pangalan ang key at i-click ang Gumawa. Ang buong key ay ipapakita isang beses lang sa berdeng banner:

4. Kopyahin agad ang key — isang beses lang ito ipinapakita. Kung mawala ito, kakailanganin ninyong gumawa ng bago. Pagkatapos ninyong i-dismiss ang banner, ang prefix lang ang nakaimbak:

Mga Access Scope

Kapag gumawa kayo ng key maaari ninyo itong gawing read-only o iwanang full-access:

Scope	Pinapayagan
Full access (default)	Read at write — maglista ng data at gumawa, mag-isyu, mag-update, o magbura.
Read-only	Mga ligtas na GET request lamang. Anumang mutating request (POST, PUT, PATCH, DELETE) ay tinatanggihan gamit ang 403 Forbidden.

Gumamit ng read-only key para sa mga integration na kailangan lang magbasa ng inyong data (reporting, dashboard, backup) para hindi mabago ng isang na-leak na key ang anumang bagay. I-tick ang Read-only key sa create form; ang mga read-only key ay nagpapakita ng Read-only badge sa listahan. Ang mga key na ginawa bago umiral ang mga scope ay pinapanatili ang full access.

Format ng Key

Ang mga API key ay gumagamit ng bws_ prefix na sinusundan ng 32-character hex string:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Paggamit ng API Keys sa mga Request

Isama ang API key sa X-Api-Key header ng bawat API request:

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

Tingnan ang pahina ng Authentication para sa buong detalye sa API authentication.

Mga Limitasyon ng Key Bawat Plan

Ang bilang ng mga API key na maaari ninyong gawin ay nakadepende sa inyong plan:

Plan	Limitasyon ng API Key
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Pagbura ng Key

1. Buksan ang pahina ng API Keys.
2. Hanapin ang key na gusto ninyong burahin.
3. I-click ang Burahin.
4. Kumpirmahin ang pagbura.

Pagkatapos burahin, agad na hihinto sa paggana ang key. Ang anumang aplikasyon na gumagamit ng key na iyon ay tatanggap ng authentication error.