API ključevi

API ključevi omogućuju programski pristup badges.ninja REST API-ju. Koristite ih za automatizaciju izrade, izdavanja i upravljanja značkama iz vlastitih aplikacija.

Izrada API ključa

1. Otvorite stranicu API Keys na bočnoj traci.
2. Kliknite Create API Key. Otvara se ugrađeni obrazac:

3. Dajte ključu naziv i kliknite Create. Cijeli ključ prikazuje se samo jednom na zelenom banneru:

4. Odmah kopirajte ključ — cijeli ključ se prikazuje samo jednom. Ako ga izgubite, morat ćete izraditi novi. Nakon što zatvorite banner, nadzorna ploča prikazuje samo prefiks ključa (npr. bws_a1b2c3d4...); cijeli ključ ostaje pohranjen na poslužitelju radi autentifikacije vaših zahtjeva:

Svaki redak prikazuje i kada je ključ izrađen te, nakon što je korišten, vremensku oznaku last used kako biste lako uočili zastarjele ključeve.

Opsezi pristupa

Pri izradi ključa možete ga postaviti kao samo za čitanje ili ostaviti s punim pristupom:

Opseg	Dopušta
Puni pristup (zadano)	Čitanje i pisanje — popis podataka te izrada, izdavanje, ažuriranje ili brisanje.
Samo za čitanje	Samo sigurni GET zahtjevi. Svaki zahtjev koji mijenja podatke (POST, PUT, PATCH, DELETE) odbija se s 403 Forbidden.

Koristite ključ samo za čitanje za integracije koje trebaju samo čitati vaše podatke (izvještavanje, nadzorne ploče, sigurnosne kopije) kako procurjeli ključ ne bi mogao ništa promijeniti. U obrascu za izradu označite Read-only key; ključevi samo za čitanje u popisu imaju oznaku Read-only. Ključevi izrađeni prije uvođenja opsega zadržavaju puni pristup.

Format ključa

API ključevi koriste prefiks bws_ iza kojeg slijedi heksadecimalni niz od 32 znaka:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Korištenje API ključeva u zahtjevima

Uključite API ključ u zaglavlje X-Api-Key svakog API zahtjeva:

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

Pogledajte stranicu Autentifikacija za sve pojedinosti o autentifikaciji API-ja.

Ograničenja ključeva po planu

Broj API ključeva koje možete izraditi ovisi o vašem planu:

Plan	Ograničenje API ključeva
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Istek ključa

Svaki API ključ istječe godinu dana nakon izrade. Kad ključ istekne, prestaje autentificirati zahtjeve, jednako kao da je izbrisan. Izradite novi ključ prije nego stari istekne kako biste izbjegli prekid rada.

Brisanje ključa

1. Otvorite stranicu API Keys.
2. Pronađite ključ koji želite izbrisati.
3. Kliknite Delete.
4. Potvrdite brisanje.

Nakon brisanja ključ odmah prestaje raditi. Sve aplikacije koje koriste taj ključ primit će pogreške autentifikacije.