Det publika hjälpcenter-API:t
Vill ni ha hjälpcentrets innehåll men er egen design? Läs det publika API:t direkt. Ingen nyckel behövs — det exponerar bara publicerade, publika artiklar och aldrig någon kunddata.
Ändpunkterna
| Metod och väg | Ger |
|---|---|
GET /api/public/kb/categories | Publika kategorier med artikelantal |
GET /api/public/kb/articles?category=&page= | Lista publicerade artiklar |
GET /api/public/kb/articles/<slug> | En artikel: full Markdown + relaterade |
GET /api/public/kb/search?q= | Fulltextsök |
GET /api/public/kb/config | Publik design: färg, texter, formulärfält |
POST /api/public/kb/chat | Fråga AI-chatboten |
POST /api/public/kb/articles/<slug>/feedback | { "helpful": true } |
Exempel:
curl "https://din-arbetsyta.supportifier.app/api/public/kb/search?q=uppsagning"
Chatt-svaret strömmar
POST /api/public/kb/chat svarar med NDJSON: en rad per textbit
({"type":"delta","text":"…"}) och en avslutande rad med källorna
({"type":"done","sources":[…]}). Rendera delarna allteftersom — det är
skillnaden mellan att kännas snabbt och att kännas trasigt.
Den ändpunkten är hårdare begränsad i takt än söket, eftersom varje anrop är ett riktigt modellanrop.
Tre sätt att integrera — välj ett
- Länka till
/help. Noll kod. Fungerar direkt, går att designa i era färger. - Bädda in widgeten. En script-tagg. Sök, AI och kontakt på era befintliga sidor.
- Läs API:t och rendera själva. Full kontroll — och fullt underhåll. Välj det när hjälpcentret måste vara en del av er egen sajt på riktigt.
De flesta har mest nytta av 1 eller 2. Alternativ 3 lönar sig när ni redan har ett designsystem allt måste passa in i.
Sökmotorer
/help/sitemap.xml listar era publicerade artiklar. Lämna in den i Google
Search Console — hjälpcenterartiklar rankar ofta bra på "varumärke + fråga",
vilket fångar kunder innan de blir ärenden.