API-võtmed

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

API-võtme loomine

1. Ava küljemenüüst leht API-võtmed.
2. Klõpsa Loo API-võti. Avaneb vormi osa:

3. Anna võtmele nimi ja klõpsa Loo. Täielik võti kuvatakse üks kord rohelisel ribal:

4. Kopeeri võti kohe — see kuvatakse ainult üks kord. Kui kaotad selle, pead looma uue. Pärast riba sulgemist salvestatakse ainult prefiks:

Juurdepääsu ulatused

Kui sa võtme lood, saad muuta selle kirjutuskaitstuks või jätta täieliku juurdepääsuga:

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

Kasuta kirjutuskaitstud 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 Kirjutuskaitstud võti; kirjutuskaitstud võtmetel kuvatakse loendis Kirjutuskaitstud märgis. Enne ulatuste olemasolu loodud võtmed säilitavad täieliku juurdepääsu.

Võtme vorming

API-võtmed kasutavad bws_ prefiksit, millele järgneb 32-tähemärgiline heks-string:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API-võtmete kasutamine päringutes

Lisa API-võti iga API-päringu päisesse X-Api-Key:

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

Vt täielikke üksikasju API-autentimise kohta lehelt Autentimine.

Võtme piirangud plaani kohta

API-võtmete arv, mida saad luua, sõltub sinu plaanist:

Plaan	API-võtme piirang
Free	1
Starter ($9/kuus)	5
Pro ($29/kuus)	20

Võtme kustutamine

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

Kui võti on kustutatud, lakkab see kohe töötamast. Rakendused, mis seda võtit kasutavad, saavad autentimisvigu.