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-символен hex низ:

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

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