API ključi

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

Ustvarjanje API ključa

1. V stranski vrstici odprite stran API ključi.
2. Kliknite Ustvari API ključ. Odpre se vgrajeni obrazec:

3. Poimenujte ključ in kliknite Ustvari. Celoten ključ se prikaže samo enkrat na zelenem traku:

4. Ključ takoj kopirajte — prikaže se le enkrat. Če ga izgubite, boste morali ustvariti novega. Ko zaprete trak, se shrani le predpona:

Obsegi dostopa

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

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

Za integracije, ki morajo vaše podatke le brati (poročanje, nadzorne plošče, varnostne kopije), uporabite ključ samo za branje, tako da uhajanje ključa ne more ničesar spremeniti. V obrazcu za ustvarjanje označite Ključ samo za branje; ključi samo za branje v seznamu prikažejo oznako Samo za branje. Ključi, ustvarjeni pred obstojem obsegov, obdržijo poln dostop.

Oblika ključa

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Uporaba API ključev v zahtevah

Vključite API ključ v glavo X-Api-Key vsake API zahteve:

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

Za podrobnosti o avtentikaciji API si oglejte stran Avtentikacija.

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/mes)	5
Pro ($29/mes)	20

Brisanje ključa

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

Po brisanju ključ takoj preneha delovati. Vse aplikacije, ki ta ključ uporabljajo, bodo prejele napake avtentikacije.