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. Потвърдете изтриването.

След като бъде изтрит, ключът незабавно спира да работи. Всички приложения, които го използват, ще получават грешки при удостоверяване.