Skip to content

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-award, at pamamahala ng badge mula sa inyong sariling mga aplikasyon.

Mga API Key — walang laman na estado

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:

Gumawa ng key — pangalan na form

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

Bagong gawa na key na ipinakita nang isang beses lang

  1. 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:

Listahan ng keys na nagpapakita ng masked prefix

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:

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

PlanLimitasyon ng API Key
Free1
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.

Pagkumpirma ng pagbura ng key — agarang revocation

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

badges.ninja Documentation