API-avaimet

API-avainten avulla pääset käyttämään badges.ninjan REST API:a ohjelmallisesti. Käytä niitä merkkien luomisen, myöntämisen ja hallinnan automatisointiin omista sovelluksistasi.

API-avaimen luominen

1. Avaa sivupalkista API-avaimet-sivu.
2. Napsauta Luo API-avain. Rivinsisäinen lomake aukeaa:

3. Anna avaimelle nimi ja napsauta Luo. Koko avain paljastetaan vain kerran vihreässä bannerissa:

4. Kopioi avain heti — koko avain näytetään vain kerran. Jos kadotat sen, sinun on luotava uusi. Kun suljet bannerin, hallintapaneeli näyttää vain avaimen etuliitteen (esim. bws_a1b2c3d4...); koko avain pysyy tallennettuna palvelimelle pyyntöjesi todentamista varten:

Jokaisella rivillä näkyy myös avaimen luontiaika ja, kun avainta on käytetty, viimeksi käytetty -aikaleima, jotta huomaat käyttämättömät avaimet.

Käyttöoikeudet

Avainta luodessasi voit tehdä siitä vain luku -avaimen tai jättää sen täysoikeuksiseksi:

Oikeus	Sallii
Täysi käyttöoikeus (oletus)	Luku ja kirjoitus — tietojen listaus sekä luominen, myöntäminen, päivittäminen tai poistaminen.
Vain luku	Vain turvalliset GET-pyynnöt. Kaikki muuttavat pyynnöt (POST, PUT, PATCH, DELETE) hylätään vastauksella 403 Forbidden.

Käytä vain luku -avainta integraatioihin, jotka tarvitsevat tietojasi vain luettaviksi (raportointi, hallintapaneelit, varmuuskopiot), jotta vuotanut avain ei voi muuttaa mitään. Valitse luontilomakkeessa Vain luku -avain; vain luku -avaimissa näkyy luettelossa Vain luku -merkki. Ennen käyttöoikeuksien käyttöönottoa 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 heksamerkkijono:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API-avainten käyttö pyynnöissä

Lisää 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 API:n todentamisen tiedot sivulta Todennus.

Avainten enimmäismäärä paketeittain

Luotavien API-avainten määrä riippuu paketistasi:

Paketti	API-avainten raja
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Avaimen vanheneminen

Jokainen API-avain vanhenee vuoden kuluttua luomisestaan. Kun avain on vanhentunut, se ei enää todenna pyyntöjä, aivan kuin se olisi poistettu. Luo uusi avain ennen vanhan vanhenemista, jotta vältät katkoksen.

Avaimen poistaminen

1. Avaa API-avaimet-sivu.
2. Etsi poistettava avain.
3. Napsauta Poista.
4. Vahvista poisto.

Poistettu avain lakkaa toimimasta välittömästi. Kaikki avainta käyttävät sovellukset saavat todennusvirheitä.