Skip to content

API raktai

API raktai leidžia programiškai pasiekti badges.ninja REST API. Naudokite juos ženklelių kūrimo, apdovanojimo ir valdymo automatizavimui iš savo programų.

API raktai — tuščia būsena

API rakto sukūrimas

  1. Šoninėje juostoje atidarykite puslapį API raktai.
  2. Spustelėkite Sukurti API raktą. Atsidaro įterptas formos laukas:

Sukurti raktą — pavadinimo forma

  1. Suteikite raktui pavadinimą ir spustelėkite Sukurti. Pilnas raktas atskleidžiamas vieną kartą žaliame baneryje:

Naujai sukurtas raktas atskleistas vieną kartą

  1. Nedelsdami nukopijuokite raktą — jis rodomas tik vieną kartą. Jei jį pametėte, turėsite sukurti naują. Uždarius banerį, saugomas tik prefiksas:

Raktų sąrašas, rodantis maskuotą prefiksą

Rakto formatas

API raktai naudoja bws_ prefiksą, po kurio eina 32 simbolių heks eilutė:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API raktų naudojimas užklausose

Įtraukite API raktą į kiekvienos API užklausos antraštę X-Api-Key:

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

Pilną informaciją apie API autentikavimą žr. puslapyje Autentikavimas.

Raktų limitai kiekvienam planui

API raktų skaičius, kuriuos galite sukurti, priklauso nuo jūsų plano:

PlanasAPI raktų limitas
Free1
Starter ($9/mėn)5
Pro ($29/mėn)20

Rakto ištrynimas

  1. Atidarykite puslapį API raktai.
  2. Raskite raktą, kurį norite ištrinti.
  3. Spustelėkite Ištrinti.
  4. Patvirtinkite ištrynimą.

Rakto ištrynimo patvirtinimas — atšaukimas yra nedelsiant

Ištrynus raktą, jis nedelsiant nustoja veikti. Bet kokios programos, naudojančios šį raktą, gaus autentikavimo klaidas.

badges.ninja Documentation