API-nycklar
API-nycklar ger program åtkomst till er arbetsytas data: ärenden, kunskapsbas och rapporter. API:t ingår för alla arbetsytor.
Skapa en nyckel
Inställningar → Integrationer & API → API-nycklar → Skapa API-nyckel. Bara administratörer kan skapa nycklar, och en nyckel kan inte skapa nya nycklar.
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, x-api-key eller Authorization: Bearer:
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. Er arbetsytas exakta adress står under Ert konto på samma sida.
Vad ni kommer åt
| Väg | Användning |
|---|---|
GET /api/tickets | Läs ärenden — ?status=, ?since= för att hämta ändringar, ?search= |
GET /api/tickets/:id, PATCH, POST …/send | Läs, uppdatera och svara på ett ärende |
POST /api/tickets | Skapa ärenden |
POST /api/webhook/ticket | Skapa ärenden från era system, se Skapa ärenden från era egna system |
GET/POST /api/knowledge | Läs och importera artiklar |
GET /api/reports | Rapportdata till er egen dashboard, ?export=tickets för raderna |
Hela dokumentationen, med fält och svar, finns under Inställningar → Integrationer & API → Dokumentation. 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
- Stäng av eller 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. Varje nyckels senaste användning syns i listan.
Takt-begränsning
Det finns ingen global gräns per nyckel. Enskilda dyra ändpunkter är
begränsade per anropare — till exempel utskick av svar (30 per minut) och
webhooken (30 per minut) — och svarar då med 429 och Retry-After. Bygger ni
något som hämtar mycket data: använd ?since= i stället för att hämta allt
varje gång.