Chei API

Cheile API îți permit să accesezi programatic API-ul REST badges.ninja. Folosește-le pentru a automatiza crearea, emiterea și gestionarea insignelor din propriile aplicații.

Crearea unei chei API

1. Deschide pagina API Keys din bara laterală.
2. Apasă Create API Key. Se deschide un formular în linie:

3. Dă-i cheii un nume și apasă Create. Cheia completă este afișată o singură dată, pe un banner verde:

4. Copiază cheia imediat — cheia completă este afișată o singură dată. Dacă o pierzi, va trebui să creezi una nouă. După ce închizi bannerul, panoul de control afișează doar prefixul cheii (de ex. bws_a1b2c3d4...); cheia completă rămâne stocată pe server pentru a-ți autentifica cererile:

Fiecare rând afișează și momentul creării cheii și, după ce a fost folosită, un marcaj temporal last used, ca să poți identifica cheile neutilizate.

Domenii de acces

Când creezi o cheie, o poți face doar pentru citire sau o poți lăsa cu acces complet:

Domeniu	Permite
Acces complet (implicit)	Citire și scriere — listarea datelor și crearea, emiterea, actualizarea sau ștergerea lor.
Doar citire	Doar cereri GET sigure. Orice cerere care modifică date (POST, PUT, PATCH, DELETE) este respinsă cu 403 Forbidden.

Folosește o cheie doar pentru citire în integrările care trebuie doar să citească datele tale (rapoarte, panouri de control, copii de siguranță), astfel încât o cheie compromisă să nu poată modifica nimic. Bifează Read-only key în formularul de creare; cheile doar pentru citire afișează în listă o insignă Read-only. Cheile create înainte de apariția domeniilor de acces păstrează accesul complet.

Formatul cheii

Cheile API folosesc prefixul bws_ urmat de un șir hexazecimal de 32 de caractere:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Folosirea cheilor API în cereri

Include cheia API în antetul X-Api-Key al fiecărei cereri API:

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

Consultă pagina Autentificare pentru detalii complete despre autentificarea API.

Limite de chei pe plan

Numărul de chei API pe care le poți crea depinde de plan:

Plan	Limită de chei API
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Expirarea cheilor

Fiecare cheie API expiră la un an după creare. După expirare, cheia nu mai autentifică cereri, exact ca și cum ar fi fost ștearsă. Creează o cheie nouă înainte ca cea veche să expire, pentru a evita întreruperile.

Ștergerea unei chei

1. Deschide pagina API Keys.
2. Găsește cheia pe care vrei să o ștergi.
3. Apasă Delete.
4. Confirmă ștergerea.

După ștergere, cheia nu mai funcționează imediat. Orice aplicație care folosește cheia respectivă va primi erori de autentificare.