API-avaimet

API-avaimet antavat sinulle ohjelmallisen pääsyn badges.ninja REST APIin. Käytä niitä merkkien luomisen, myöntämisen ja hallinnan automatisointiin omista sovelluksistasi.

API-avaimen luominen

1. Avaa sivupalkista sivu API-avaimet.
2. Napsauta Luo API-avain. Sisäänrakennettu lomake avautuu:

3. Anna avaimelle nimi ja napsauta Luo. Täydellinen avain näytetään kerran vihreässä bannerissa:

4. Kopioi avain välittömästi — se näytetään vain kerran. Jos menetät sen, sinun on luotava uusi. Bannerin sulkemisen jälkeen vain etuliite tallennetaan:

Käyttöoikeusalueet

Kun luot avaimen, voit tehdä siitä vain luku -avaimen tai jättää sen täysin käyttöoikeuksin varustetuksi:

Alue	Sallii
Täysi käyttöoikeus (oletus)	Luku ja kirjoitus — luetteloi tietoja sekä luo, myönnä, päivitä tai poista.
Vain luku	Vain turvalliset GET-pyynnöt. Kaikki muuttavat pyynnöt (POST, PUT, PATCH, DELETE) hylätään virheellä 403 Forbidden.

Käytä vain luku -avainta integraatioissa, joiden tarvitsee vain lukea tietojasi (raportointi, koontinäytöt, varmuuskopiot), jotta vuotanut avain ei voi muuttaa mitään. Rastita Vain luku -avain luontilomakkeessa; vain luku -avaimet näyttävät luettelossa Vain luku -merkin. Ennen käyttöoikeusalueiden olemassaoloa luodut avaimet säilyttävät täyden käyttöoikeuden.

Avaimen muoto

API-avaimet käyttävät etuliitettä bws_, jota seuraa 32-merkkinen hex-merkkijono:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API-avainten käyttö pyynnöissä

Sisällytä API-avain jokaisen API-pyynnön X-Api-Key-otsikkoon:

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

Katso sivulta Todennus täydet tiedot API-todennuksesta.

Avainten rajat tilausluokittain

Luomiesi API-avainten määrä riippuu tilauksestasi:

Tilaus	API-avainten raja
Free	1
Starter (9 USD/kk)	5
Pro (29 USD/kk)	20

Avaimen poistaminen

1. Avaa sivu API-avaimet.
2. Etsi avain, jonka haluat poistaa.
3. Napsauta Poista.
4. Vahvista poisto.

Kun avain on poistettu, se lakkaa toimimasta välittömästi. Avainta käyttävät sovellukset saavat todennusvirheitä.