Przejdź do treści
Intum

Helplinki

Aktualizacja: • 2 min czytania

Przejdź do sekcji

  1. Helplinki — kontekstowa pomoc w aplikacji
  2. Jak to działa
  3. Właściwości helplinku
  4. Automatyczne tworzenie
  5. Statystyki
  6. Wielojęzyczność
  7. Testowanie

Endpointy

Metoda Ścieżka Opis
GET /kb/helplinks.json Lista helplinków
GET /kb/helplinks/:id.json Pojedynczy helplink
POST /kb/helplinks.json Utworzenie helplinku
PATCH /kb/helplinks/:id.json Aktualizacja helplinku
DELETE /kb/helplinks/:id.json Usunięcie helplinku
GET /kb/helplinks/get_helplinks_content Pobranie treści (publiczny, bez autoryzacji)

Autoryzacja: Authorization: Bearer TOKEN (uprawnienie: kb)

Pole Typ Wymagane Opis
key string tak Klucz helplinku (unikalny per baza)
knowledge_base_id integer tak ID bazy wiedzy
entry_id integer nie ID powiązanego wpisu
content string nie Treść HTML
section string nie Anchor sekcji (np. #intro)
active boolean nie Czy aktywny (domyślnie false)

Widget endpoint (publiczny)

GET /kb/helplinks/get_helplinks_content?keys[]=tasks.create&keys[]=settings.email&kb_token=TOKEN&lang=pl
Parametr Opis
keys[] Tablica kluczy helplinków
kb_token Token bazy wiedzy
lang Język (opcjonalny, dla wielojęzyczności)

Odpowiedź:

{
  "tasks.create": {
    "path": "/pomoc/zadania/jak-dodac-zadanie",
    "content": "<p>Krótki opis...</p>",
    "active": true
  },
  "settings.email": {
    "path": null,
    "content": null,
    "active": false
  }
}

Przykład utworzenia

{
  "api_token": "TOKEN",
  "helplink": {
    "key": "tasks.create",
    "knowledge_base_id": 1,
    "entry_id": 123,
    "active": true,
    "section": "#tworzenie"
  }
}