API-dokumentation

Byg hurtige integrationer med NPS API'et. Base URL: /api

Prøv med dit token

Indsæt token herunder og brug det i dine terminal-kommandoer.

Værdien bruges kun i din browser og sendes ikke fra denne side.
Endpoint-overblik
Method Path Auth Beskrivelse
GET/api/campaignsBearer tokenHent kampagner
GET/api/campaigns/{id}Bearer tokenHent kampagne via id
POST/api/campaignsBearer tokenOpret kampagne
GET/api/metricsBearer tokenHent samlede metrics
POST/api/responsesRespondent tokenIndsend svar
Sådan får du et bruger-API-token
  1. Log ind i NPS-appen.
  2. Gå til Indstillinger.
  3. I API Tokens indtaster du et navn og klikker Generate.
  4. Kopiér token med det samme (det vises kun én gang).
Sådan bruger du API'et

Send token med i Authorization-headeren:

Authorization: Bearer DIT_API_TOKEN
Hent kampagner
curl -X GET "http://localhost:8080/api/campaigns" \
  -H "Authorization: Bearer DIT_API_TOKEN"
Hent kampagne via id
curl -X GET "http://localhost:8080/api/campaigns/1" \
  -H "Authorization: Bearer DIT_API_TOKEN"
Opret kampagne
curl -X POST "http://localhost:8080/api/campaigns" \
  -H "Authorization: Bearer DIT_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q1 NPS",
    "description": "Første kvartals undersøgelse"
  }'
Indsend svar (offentligt survey-token)
curl -X POST "http://localhost:8080/api/responses?token=RESPONDENT_TOKEN&rating=10&comment=Super"
Hent samlede metrics
curl -X GET "http://localhost:8080/api/metrics" \
  -H "Authorization: Bearer DIT_API_TOKEN"