API ključevi

API ključevi vam omogućuju programski pristup REST API-ju badges.ninja. Koristite ih za automatizaciju stvaranja, izdavanja i upravljanja bedževima iz vlastitih aplikacija.

Stvaranje API ključa

1. U bočnoj traci otvorite stranicu API ključevi.
2. Kliknite Stvori API ključ. Otvara se ugrađeni obrazac:

3. Imenujte ključ i kliknite Stvori. Cijeli ključ prikazuje se samo jednom na zelenoj traci:

4. Ključ odmah kopirajte — prikazuje se samo jednom. Ako ga izgubite, morat ćete stvoriti novi. Nakon zatvaranja trake pohranjuje se samo prefiks:

Opsezi pristupa

Kada stvarate ključ, možete ga postaviti kao samo za čitanje ili ga ostaviti s potpunim pristupom:

Opseg	Dopušta
Potpuni pristup (zadano)	Čitanje i pisanje — ispis podataka te stvaranje, 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 kojima je potrebno samo čitati vaše podatke (izvještavanje, nadzorne ploče, sigurnosne kopije) kako procureli ključ ne bi mogao ništa promijeniti. Označite Ključ samo za čitanje u obrascu za stvaranje; ključevi samo za čitanje prikazuju oznaku Samo za čitanje na popisu. Ključevi stvoreni prije nego što su opsezi postojali zadržavaju potpuni pristup.

Format ključa

API ključevi koriste prefiks bws_ praćen 32-znakovnim heksadecimalnim nizom:

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"

Za sve pojedinosti o autentifikaciji API-ja pogledajte stranicu Autentifikacija.

Ograničenja ključeva po planu

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

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

Brisanje ključa

1. Otvorite stranicu API ključevi.
2. Pronađite ključ koji želite obrisati.
3. Kliknite Obriši.
4. Potvrdite brisanje.

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