Skip to content

API atslēgas

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

API atslēgas — tukšs stāvoklis

API atslēgas izveide

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

Izveidot atslēgu — nosaukuma veidlapa

  1. Piešķiriet atslēgai nosaukumu un noklikšķiniet uz Izveidot. Pilna atslēga tiek atklāta vienu reizi uz zaļa banera:

Tikko izveidotā atslēga, atklāta vienreiz

  1. 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:

Atslēgu saraksts, kas parāda maskēto prefiksu

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:

bash
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ānsAPI atslēgu ierobežojums
Free1
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.

Atslēgas dzēšanas apstiprinājums — atsaukšana ir tūlītēja

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.

badges.ninja Documentation