API atslēgas

API atslēgas ļauj jums programmatiski piekļūt badges.ninja REST API. Izmantojiet tās, lai automatizētu nozīmju izveidi, izsniegšanu un pārvaldību no savām lietotnēm.

API atslēgas izveide

1. Sānjoslā atveriet lapu API atslēgas.
2. Noklikšķiniet uz Izveidot API atslēgu. Atveras iekļauta veidlapa:

3. Ievadiet atslēgas nosaukumu un noklikšķiniet uz Izveidot. Pilnā atslēga tiek parādīta vienu reizi zaļā joslā:

4. Nekavējoties nokopējiet atslēgu — pilnā atslēga tiek parādīta tikai vienu reizi. Ja to pazaudēsiet, jums būs jāizveido jauna. Pēc joslas aizvēršanas informācijas panelī vienmēr tiek rādīts tikai atslēgas prefikss (piemēram, bws_a1b2c3d4...); pilnā atslēga paliek glabāta serverī, lai autentificētu jūsu pieprasījumus:

Katrā rindā tiek rādīts arī atslēgas izveides laiks, un pēc tās izmantošanas — pēdējās izmantošanas laika zīmogs, lai jūs varētu pamanīt neizmantotas atslēgas.

Piekļuves tvērumi

Veidojot atslēgu, varat to padarīt tikai lasāmu vai atstāt pilnu piekļuvi:

Tvērums	Atļauj
Pilna piekļuve (noklusējums)	Lasīt un rakstīt — skatīt datus un izveidot, izsniegt, atjaunināt vai dzēst.
Tikai lasīšana	Tikai drošus GET pieprasījumus. Jebkurš datus mainošs pieprasījums (POST, PUT, PATCH, DELETE) tiek noraidīts ar 403 Forbidden.

Izmantojiet tikai lasāmu atslēgu integrācijām, kurām jūsu dati tikai jālasa (pārskati, informācijas paneļi, rezerves kopijas), lai nopludināta atslēga neko nevarētu mainīt. Izveides veidlapā atzīmējiet Tikai lasāma atslēga; tikai lasāmas atslēgas sarakstā ir atzīmētas ar zīmi Tikai lasīšana. Atslēgas, kas izveidotas pirms tvērumu ieviešanas, saglabā pilnu piekļuvi.

Atslēgas formāts

API atslēgas izmanto prefiksu bws_, kam seko 32 rakstzīmju heksadecimāla virkne:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API atslēgu izmantošana pieprasījumos

Katra API pieprasījuma galvenē X-Api-Key norādiet API atslēgu:

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

Plašāku informāciju par API autentifikāciju skatiet lapā Autentifikācija.

Atslēgu ierobežojumi pa plāniem

API atslēgu skaits, ko varat izveidot, ir atkarīgs no jūsu plāna:

Plāns	API atslēgu ierobežojums
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Atslēgas derīguma termiņš

Katras API atslēgas derīguma termiņš beidzas vienu gadu pēc tās izveides. Kad atslēgas termiņš beidzies, tā vairs neautentificē pieprasījumus — tieši tāpat, it kā tā būtu izdzēsta. Izveidojiet jaunu atslēgu, pirms vecā zaudē derīgumu, lai izvairītos no pārtraukumiem.

Atslēgas dzēšana

1. Atveriet lapu API atslēgas.
2. Atrodiet atslēgu, kuru vēlaties dzēst.
3. Noklikšķiniet uz Dzēst.
4. Apstipriniet dzēšanu.

Pēc dzēšanas atslēga nekavējoties pārstāj darboties. Visas lietotnes, kas izmanto šo atslēgu, saņems autentifikācijas kļūdas.