API кључеви

API кључеви вам омогућавају програмски приступ REST API-ју badges.ninja. Користите их за аутоматизацију креирања, издавања и управљања значкама из сопствених апликација.

Креирање API кључа

1. Отворите страницу API Keys у бочном менију.
2. Кликните Create API Key. Отвара се уграђени формулар:

3. Дајте кључу име и кликните Create. Пуни кључ се приказује једном на зеленом банеру:

4. Одмах копирајте кључ — приказује се само једном. Ако га изгубите, мораћете да направите нови. Након одбацивања банера, чува се само префикс:

Опсези приступа

Када креирате кључ, можете га поставити као само за читање или га оставити са пуним приступом:

Опсег	Дозвољава
Пуни приступ (подразумевано)	Читање и писање — листање података и креирање, издавање, ажурирање или брисање.
Само за читање	Само безбедни GET захтеви. Сваки захтев који мења податке (POST, PUT, PATCH, DELETE) се одбија са 403 Forbidden.

Користите кључ само за читање за интеграције којима је потребно само да читају ваше податке (извештавање, контролне табле, резервне копије) како процурели кључ не би могао ништа да промени. Означите Кључ само за читање у обрасцу за креирање; кључеви само за читање приказују ознаку Само за читање на листи. Кључеви креирани пре него што су опсези постојали задржавају пуни приступ.

Формат кључа

API кључеви користе префикс bws_ праћен хексадецималним низом од 32 карактера:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Коришћење API кључева у захтевима

Укључите API кључ у заглавље X-Api-Key сваког API захтева:

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

Пуне детаље о API аутентификацији погледајте на страници Аутентификација.

Лимити кључева по плану

Број API кључева које можете да креирате зависи од плана:

План	Лимит API кључева
Free	1
Starter ($9/мес)	5
Pro ($29/мес)	20

Брисање кључа

1. Отворите страницу API Keys.
2. Пронађите кључ који желите да обришете.
3. Кликните Delete.
4. Потврдите брисање.

Након брисања кључ одмах престаје да ради. Све апликације које га користе добијаће грешке аутентификације.