API raktai

API raktai leidžia programiškai pasiekti badges.ninja REST API. Naudokite juos ženklelių kūrimo, išdavimo ir valdymo automatizavimui iš savo programų.

API rakto sukūrimas

1. Šoninėje juostoje atidarykite puslapį API raktai.
2. Spustelėkite Sukurti API raktą. Atsidaro įterptas formos laukas:

3. Suteikite raktui pavadinimą ir spustelėkite Sukurti. Pilnas raktas atskleidžiamas vieną kartą žaliame baneryje:

4. Nedelsdami nukopijuokite raktą — jis rodomas tik vieną kartą. Jei jį pametėte, turėsite sukurti naują. Uždarius banerį, saugomas tik prefiksas:

Prieigos sritys

Kai sukuriate raktą, galite jį padaryti tik skaitymo arba palikti visos prieigos:

Sritis	Leidžia
Visa prieiga (numatytoji)	Skaityti ir rašyti — peržiūrėti duomenų sąrašą bei kurti, išduoti, atnaujinti ar trinti.
Tik skaitymo	Tik saugias GET užklausas. Bet kokia keičianti užklausa (POST, PUT, PATCH, DELETE) atmetama su 403 Forbidden.

Naudokite tik skaitymo raktą integracijoms, kurioms reikia tik skaityti jūsų duomenis (ataskaitoms, skydeliams, atsarginėms kopijoms), kad nutekintas raktas nieko negalėtų pakeisti. Kūrimo formoje pažymėkite Tik skaitymo raktas; tik skaitymo raktai sąraše rodo ženklelį Tik skaitymo. Raktai, sukurti prieš atsirandant sritims, išlaiko visą prieigą.

Rakto formatas

API raktai naudoja bws_ prefiksą, po kurio eina 32 simbolių heks eilutė:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API raktų naudojimas užklausose

Įtraukite API raktą į kiekvienos API užklausos antraštę X-Api-Key:

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

Pilną informaciją apie API autentikavimą žr. puslapyje Autentikavimas.

Raktų limitai kiekvienam planui

API raktų skaičius, kuriuos galite sukurti, priklauso nuo jūsų plano:

Planas	API raktų limitas
Free	1
Starter ($9/mėn)	5
Pro ($29/mėn)	20

Rakto ištrynimas

1. Atidarykite puslapį API raktai.
2. Raskite raktą, kurį norite ištrinti.
3. Spustelėkite Ištrinti.
4. Patvirtinkite ištrynimą.

Ištrynus raktą, jis nedelsiant nustoja veikti. Bet kokios programos, naudojančios šį raktą, gaus autentikavimo klaidas.