API кључеви

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

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

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

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

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

Сваки ред приказује и када је кључ креиран и, након употребе, временску ознаку last used да бисте лакше уочили неискоришћене кључеве.

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

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

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

Користите кључ само за читање за интеграције које само читају ваше податке (извештавање, контролне табле, резервне копије) да процурели кључ не би могао ништа да измени. У формулару за креирање означите Read-only key; кључеви само за читање имају ознаку Read-only на листи. Кључеви креирани пре увођења опсега задржавају пун приступ.

Формат кључа

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

Истек кључа

Сваки API кључ истиче годину дана након креирања. Када кључ истекне, престаје да аутентификује захтеве, као да је обрисан. Направите нови кључ пре него што стари истекне да бисте избегли прекид.

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

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

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