Getting Started

Authenticatie

Beveilig je API-verzoeken met API-sleutels

Authenticatie

Alle Blitz Rocket API v1-eindpunten vereisen authenticatie via een API-sleutel. API-sleutels zijn gekoppeld aan een team en kunnen worden beheerd vanaf je teaminstellingenpagina.

Een API-sleutel aanmaken

  1. Log in op je Blitz Rocket-dashboard
  2. Ga naar Instellingen → API-sleutels
  3. Klik op API-sleutel aanmaken
  4. Kies een sleutetype (Publiek of Privé)
  5. Kopieer je sleutel — deze wordt slechts één keer getoond

Sleutelt Types

Publieke Sleutel

Publieke sleutels bieden alleen-lezen toegang en zijn veilig te gebruiken in client-side code. Ze kunnen toegang krijgen tot:

  • GET /api/v1/contests — Wedstrijden weergeven
  • GET /api/v1/contests/:contestId — Wedstrijddetails ophalen
  • GET /api/v1/contests/:contestId/leaderboard — Ranglijst ophalen
  • GET /api/v1/contests/:contestId/entries — Inzendingen weergeven
  • GET /api/v1/contests/:contestId/analytics — Analytics ophalen
  • GET /api/v1/entries/:entryId — Inzendingdetails ophalen
  • GET /api/v1/entries/:entryId/bonus-actions — Bonusacties ophalen
  • POST /api/v1/entries/:entryId/bonus-actions/:bonusActionId/complete — Bonusactie voltooien

Privé Sleutel

Privésleutels bieden volledige lees-/schrijftoegang tot alle eindpunten. Houd deze geheim en gebruik ze alleen in server-side code. Naast alle publieke sleutelpaden kunnen privésleutels ook:

  • POST /api/v1/contests/:contestId/entries — Inzendingen aanmaken
  • PUT /api/v1/entries/:entryId — Inzendingen bijwerken
  • POST /api/v1/entries/:entryId/disqualify — Inzendingen diskwalificeren
  • POST /api/v1/entries/:entryId/points — Punten aanpassen
  • POST /api/v1/contests/:contestId/purchases — Aankopen registreren

Je API-sleutel verzenden

Geef je API-sleutel mee in de x-api-key request header. Stuur API-sleutels niet mee in queryparameters — deze kunnen uitlekken via logs, browsergeschiedenis en referrer headers.

bash
curl -X GET https://blitzrocket.com/api/v1/contests \
  -H "x-api-key: vk_live_abc123def456"

Authenticatiefouten

Als je API-sleutel ontbreekt of ongeldig is, ontvang je een 401 Unauthorized respons:

json
{
  "success": false,
  "error": "Ontbrekende of ongeldige API-sleutel"
}

Als je een publieke sleutel gebruikt op een privé-eindpunt, ontvang je een 403 Forbidden respons:

json
{
  "success": false,
  "error": "Dit eindpunt vereist een privé API-sleutel"
}

Beste beveiligingspraktijken

  • Maak privé sleutels nooit openbaar in client-side code, openbare repositories of browserverzoeken
  • Draai sleutels regelmatig om — verwijder en maak sleutels periodiek opnieuw aan
  • Gebruik publieke sleutels voor alle client-side of browsergebaseerde integraties
  • Gebruik privésleutels alleen in beveiligde server-side omgevingen
  • Bewaar sleutels in omgevingsvariabelen, codeer ze nooit hardcoded in