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. Įveskite rakto pavadinimą ir spustelėkite Sukurti. Visas raktas parodomas vieną kartą žaliame skydelyje:

4. Nedelsdami nukopijuokite raktą — visas raktas rodomas tik vieną kartą. Jei jį pamestumėte, turėsite sukurti naują. Uždarius skydelį, informacijos suvestinėje visada rodomas tik rakto prefiksas (pvz., bws_a1b2c3d4...); visas raktas lieka saugomas serveryje jūsų užklausoms autentifikuoti:

Kiekvienoje eilutėje taip pat rodoma, kada raktas buvo sukurtas, o jį panaudojus — paskutinio naudojimo laiko žymė, kad galėtumėte pastebėti nebenaudojamus raktus.

Prieigos apimtys

Kurdami raktą galite jį padaryti tik skaitomu arba palikti visą prieigą:

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

Naudokite tik skaitomą raktą integracijoms, kurioms reikia tik skaityti jūsų duomenis (ataskaitos, informacijos suvestinės, atsarginės kopijos), kad nutekėjęs raktas nieko negalėtų pakeisti. Kūrimo formoje pažymėkite Tik skaitomas raktas; tik skaitomi raktai sąraše pažymimi ženklu Tik skaitymas. Raktai, sukurti dar prieš atsirandant apimtims, išlaiko visą prieigą.

Rakto formatas

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API raktų naudojimas užklausose

Kiekvienos API užklausos antraštėje X-Api-Key nurodykite API raktą:

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

Daugiau informacijos apie API autentifikavimą rasite puslapyje Autentifikavimas.

Raktų limitai pagal planą

Kiek API raktų galite sukurti, priklauso nuo jūsų plano:

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

Rakto galiojimo pabaiga

Kiekvieno API rakto galiojimas baigiasi praėjus vieniems metams nuo jo sukūrimo. Raktui nustojus galioti, jis nebeautentifikuoja užklausų — lygiai taip, lyg būtų ištrintas. Sukurkite naują raktą, kol senasis dar nesibaigė, kad išvengtumėte sutrikimų.

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štrintas raktas nustoja veikti iš karto. Visos programos, naudojančios tą raktą, gaus autentifikavimo klaidas.