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. Piešķiriet atslēgai nosaukumu un noklikšķiniet uz Izveidot. Pilna atslēga tiek atklāta vienu reizi uz zaļa banera:

4. Nekavējoties nokopējiet atslēgu — tā tiek parādīta tikai vienu reizi. Ja to pazaudēsiet, jums būs jāizveido jauna. Pēc banera aizvēršanas tiek saglabāts tikai prefikss:

Piekļuves tvērumi

Kad izveidojat atslēgu, jūs to varat padarīt par tikai lasāmu vai atstāt ar pilnu piekļuvi:

Tvērums	Atļauj
Pilna piekļuve (noklusējums)	Lasīt un rakstīt — uzskaitīt datus un izveidot, izsniegt, atjaunināt vai dzēst.
Tikai lasīšana	Tikai drošus GET pieprasījumus. Jebkurš 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 (atskaites, informācijas paneļi, dublējumi), lai noplūdusi atslēga neko nevarētu mainīt. Izveides veidlapā atzīmējiet Read-only key; tikai lasāmām atslēgām sarakstā tiek parādīta Read-only nozīme. Atslēgas, kas izveidotas pirms tvērumu pastāvēšanas, saglabā pilnu piekļuvi.

Atslēgas formāts

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API atslēgu izmantošana pieprasījumos

Iekļaujiet API atslēgu katra API pieprasījuma galvenē X-Api-Key:

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

Skatiet pilnu informāciju par API autentifikāciju lapā Autentifikācija.

Atslēgu ierobežojumi katram plānam

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/mēn)	5
Pro ($29/mēn)	20

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.

Kad atslēga ir dzēsta, tā nekavējoties pārstāj darboties. Jebkuras lietotnes, kas izmanto šo atslēgu, saņems autentifikācijas kļūdas.