Moduł Baza Wiedzy udostępnia API dla baz wiedzy, wpisów, kategorii, komentarzy i helplinków.
Endpointy baz wiedzy
| Metoda | Ścieżka | Opis |
|——–|———|——|
| GET | /kb/knowledge_bases.json | Lista baz wiedzy |
| GET | /kb/knowledge_bases/:id.json | Pojedyncza baza |
| POST | /kb/knowledge_bases.json | Utworzenie bazy |
| PATCH | /kb/knowledge_bases/:id.json | Aktualizacja bazy |
| DELETE | /kb/knowledge_bases/:id.json | Usunięcie bazy |
Autoryzacja: Authorization: Bearer TOKEN (uprawnienie: kb)
Pola knowledge_base
| Pole | Typ | Wymagane | Opis |
|——|—–|———-|——|
| title | string | tak | Nazwa bazy wiedzy |
| description | string | nie | Opis |
| lang | string | nie | Język: pl, en, fr, cs, sk, de, es, uk |
| template | string | nie | Szablon: protocol_basic, default, marsian, syntax |
| prefix | string | nie | Prefix URL (np. pomoc) |
| private | boolean | nie | Czy prywatna |
| category_in_url | boolean | nie | Kategoria w URL wpisu |
| content_api | string | nie | Dokumentacja API (Markdown) |
| multilang_code | string | nie | Kod grupy tłumaczeń |
Szczegółowa dokumentacja poszczególnych zasobów w osobnych wpisach:
-
Wpisy —
/kb/entries -
Kategorie —
/kb/categories -
Komentarze —
/kb/comments -
Helplinki —
/kb/helplinks