API ključi

API ključi vam omogočajo programski dostop do REST API-ja storitve badges.ninja. Uporabite jih za avtomatizacijo ustvarjanja, izdajanja in upravljanja značk iz lastnih aplikacij.

Ustvarjanje API ključa

1. V stranskem meniju odprite stran API Keys.
2. Kliknite Create API Key. Odpre se vgrajeni obrazec:

3. Ključu dodelite ime in kliknite Create. Celoten ključ je enkrat prikazan na zeleni pasici:

4. Ključ takoj kopirajte — celoten ključ je prikazan samo enkrat. Če ga izgubite, boste morali ustvariti novega. Ko pasico zaprete, nadzorna plošča prikazuje le predpono ključa (npr. bws_a1b2c3d4...); celoten ključ ostane shranjen na strežniku za overjanje vaših zahtev:

Vsaka vrstica prikazuje tudi, kdaj je bil ključ ustvarjen, in — ko je bil uporabljen — časovni žig last used, da lahko odkrijete neuporabljene ključe.

Obsegi dostopa

Ko ustvarite ključ, ga lahko nastavite kot samo za branje ali pustite s polnim dostopom:

Obseg	Dovoljuje
Poln dostop (privzeto)	Branje in pisanje — izpis podatkov ter ustvarjanje, izdajanje, posodabljanje ali brisanje.
Samo za branje	Samo varne zahteve GET. Vsaka zahteva, ki spreminja podatke (POST, PUT, PATCH, DELETE), je zavrnjena s 403 Forbidden.

Ključ samo za branje uporabite za integracije, ki podatke le berejo (poročila, nadzorne plošče, varnostne kopije), tako da razkriti ključ ne more ničesar spremeniti. V obrazcu za ustvarjanje označite Read-only key; ključi samo za branje imajo na seznamu značko Read-only. Ključi, ustvarjeni pred uvedbo obsegov, ohranijo poln dostop.

Oblika ključa

API ključi imajo predpono bws_, ki ji sledi 32-mestni šestnajstiški niz:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Uporaba API ključev v zahtevah

API ključ vključite v glavo X-Api-Key pri vsaki zahtevi API:

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

Za podrobnosti o overjanju API glejte stran Overjanje.

Omejitve ključev po paketu

Število API ključev, ki jih lahko ustvarite, je odvisno od vašega paketa:

Paket	Omejitev API ključev
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Potek veljavnosti ključa

Vsak API ključ poteče eno leto po ustvarjanju. Ko ključ poteče, ne overja več zahtev, povsem enako, kot če bi bil izbrisan. Pred iztekom starega ključa ustvarite novega, da se izognete prekinitvi.

Brisanje ključa

1. Odprite stran API Keys.
2. Poiščite ključ, ki ga želite izbrisati.
3. Kliknite Delete.
4. Potrdite brisanje.

Ko je ključ izbrisan, takoj preneha delovati. Vse aplikacije, ki uporabljajo ta ključ, bodo prejele napake overjanja.