API-sleutels

Met API-sleutels kun je programmatisch gebruikmaken van de REST API van badges.ninja. Gebruik ze om het maken, uitgeven en beheren van badges vanuit je eigen applicaties te automatiseren.

Een API-sleutel aanmaken

1. Open de pagina API-sleutels in de zijbalk.
2. Klik op API-sleutel aanmaken. Er wordt een inline formulier geopend:

3. Geef de sleutel een naam en klik op Aanmaken. De volledige sleutel wordt eenmaal getoond op een groene banner:

4. Kopieer de sleutel direct — deze wordt slechts één keer getoond. Raak je hem kwijt, dan moet je een nieuwe aanmaken. Nadat je de banner sluit, wordt alleen het voorvoegsel bewaard:

Toegangsscopes

Wanneer je een sleutel aanmaakt, kun je hem alleen-lezen maken of volledige toegang laten houden:

Scope	Staat toe
Volledige toegang (standaard)	Lezen en schrijven — gegevens opsommen en aanmaken, uitgeven, bijwerken of verwijderen.
Alleen-lezen	Alleen veilige GET-verzoeken. Elk wijzigend verzoek (POST, PUT, PATCH, DELETE) wordt geweigerd met 403 Forbidden.

Gebruik een alleen-lezen sleutel voor integraties die je gegevens alleen hoeven te lezen (rapportage, dashboards, back-ups), zodat een gelekte sleutel niets kan wijzigen. Vink Alleen-lezen sleutel aan in het aanmaakformulier; alleen-lezen sleutels tonen een Read-only-badge in de lijst. Sleutels die zijn aangemaakt voordat scopes bestonden, behouden volledige toegang.

Sleutelformaat

API-sleutels gebruiken het voorvoegsel bws_ gevolgd door een hexadecimale string van 32 tekens:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API-sleutels gebruiken in verzoeken

Voeg de API-sleutel toe aan de X-Api-Key-header bij elk API-verzoek:

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

Zie de pagina Authenticatie voor alle details over API-authenticatie.

Sleutellimieten per abonnement

Het aantal API-sleutels dat je kunt aanmaken hangt af van je abonnement:

Abonnement	Limiet API-sleutels
Free	1
Starter ($9/maand)	5
Pro ($29/maand)	20

Een sleutel verwijderen

1. Open de pagina API-sleutels.
2. Zoek de sleutel die je wilt verwijderen.
3. Klik op Verwijderen.
4. Bevestig de verwijdering.

Na verwijderen werkt de sleutel meteen niet meer. Applicaties die de sleutel gebruiken, krijgen authenticatiefouten.