API võtmed

API võtmed võimaldavad sul badges.ninja REST API-le programmeeritult ligi pääseda. Kasuta neid märkide loomise, väljastamise ja haldamise automatiseerimiseks oma rakendustest.

API võtme loomine

1. Ava külgribal leht API võtmed.
2. Klõpsa Loo API võti. Avaneb reasisene vorm:

3. Anna võtmele nimi ja klõpsa Loo. Täisvõti kuvatakse ainult üks kord rohelisel bänneril:

4. Kopeeri võti kohe — täisvõtit näidatakse ainult ühe korra. Kui sa selle kaotad, pead looma uue. Pärast bänneri sulgemist kuvab töölaud alati ainult võtme eesliidet (nt bws_a1b2c3d4...); täisvõti jääb serveris salvestatuks, et sinu päringuid autentida:

Iga rida näitab ka võtme loomise aega ning pärast kasutamist viimase kasutamise ajatemplit, et saaksid tuvastada kasutamata võtmeid.

Juurdepääsuulatused

Võtme loomisel võid selle teha ainult lugemiseks või jätta täisjuurdepääsuga:

Ulatus	Lubab
Täisjuurdepääs (vaikimisi)	Lugemine ja kirjutamine — andmete loendamine ning loomine, väljastamine, uuendamine või kustutamine.
Ainult lugemine	Ainult ohutud GET päringud. Iga muutev päring (POST, PUT, PATCH, DELETE) lükatakse tagasi vastusega 403 Forbidden.

Kasuta ainult lugemise võtit integratsioonide jaoks, mis peavad su andmeid ainult lugema (aruandlus, töölauad, varukoopiad), et lekkinud võti ei saaks midagi muuta. Märgi loomisvormis Ainult lugemise võti; ainult lugemise võtmetel kuvatakse loendis märk Ainult lugemine. Enne ulatuste olemasolu loodud võtmed säilitavad täisjuurdepääsu.

Võtme vorming

API võtmed kasutavad eesliidet bws_, millele järgneb 32-märgiline kuueteistkümnendsüsteemi string:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API võtmete kasutamine päringutes

Lisa API võti igale API päringule päisesse X-Api-Key:

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

API autentimise üksikasjad leiad lehelt Autentimine.

Võtmete limiit paketi kohta

Loodavate API võtmete arv sõltub sinu paketist:

Pakett	API võtmete limiit
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Võtme aegumine

Iga API võti aegub aasta pärast selle loomist. Kui võti on aegunud, lakkab see päringuid autentimast, täpselt nagu oleks see kustutatud. Loo uus võti enne vana aegumist, et vältida katkestust.

Võtme kustutamine

1. Ava leht API võtmed.
2. Leia võti, mida soovid kustutada.
3. Klõpsa Kustuta.
4. Kinnita kustutamine.

Kustutatud võti lakkab kohe töötamast. Kõik rakendused, mis seda võtit kasutavad, saavad autentimisvead.