API-nycklar
API-nycklar ger program åtkomst till er arbetsytas data: ärenden, kunskapsbas och rapporter.
Skapa en nyckel
Inställningar → System → API & utvecklare → Skapa nyckel.
Klartextnyckeln visas exakt en gång, vid skapandet. Kopiera den direkt till er hemlighetshantering. Vi lagrar bara en hash — vi kan inte visa nyckeln igen och kan inte återskapa den. Tappad nyckel = skapa en ny.
Använda den
Skicka nyckeln som header:
curl -H "x-api-key: DIN_NYCKEL" \
https://din-arbetsyta.supportifier.app/api/tickets
Nyckeln är bunden till er arbetsyta. En nyckel som används mot en annan arbetsytas adress avvisas.
Vad ni kommer åt
| Väg | Användning |
|---|---|
GET /api/tickets | Läs ärenden — export, egen rapportering |
GET/POST /api/knowledge | Läs och importera artiklar |
GET /api/reports | Rapportdata till er egen dashboard |
POST /api/webhook/ticket | Skapa ärenden från era system |
Hjälpcentrets publika innehåll behöver ingen nyckel — se Det publika hjälpcenter-API:t.
Skötsel
- En nyckel per system, inte en delad för allt. Då kan en enskild integration stängas av utan att allt annat slutar fungera.
- Namnge efter användning ("Retool-export", "Hemsidans formulär").
- Rotera när någon slutar och när en nyckel varit exponerad.
- Aldrig i frontendkod. En nyckel i webbläsaren är en publik nyckel.
Om en nyckel läckt
- Ta bort nyckeln i listan — den slutar gälla omedelbart.
- Skapa en ny och lägg in den där den behövs.
- Titta i händelseloggen och i ärendena efter något oväntat.
Rate-limitering
Anrop är begränsade i takt. Bygger ni något som hämtar mycket data — hämta i sidor och undvik att polla tätt. Behöver ni högre volym, hör av er.