[Intum](https://intum.fr/aide.md) / [Baza Wiedzy](https://intum.fr/aide/baza-wiedzy.md)

# [Helplinki](https://intum.fr/aide/baza-wiedzy/helplinki.md) | [API](#api)

## Helplinki — kontekstowa pomoc w aplikacji

Helplinki łączą elementy interfejsu aplikacji z artykułami w [bazie wiedzy](baza-wiedzy). Dzięki nim użytkownik może zobaczyć podpowiedź lub link do artykułu w miejscu, gdzie akurat pracuje.

## Jak to działa

1. W kodzie aplikacji umieszczasz helplink z kluczem (np. `tasks.create`)
2. W panelu helplinków przypisujesz klucz do [wpisu](wpisy-do-bazy-wiedzy) z bazy wiedzy
3. Widget helplinków automatycznie wyświetla treść lub link do artykułu

## Właściwości helplinku

- **Klucz** — unikalny identyfikator w ramach bazy (np. `settings.email`, `tasks.create`)
- **Wpis** — powiązany artykuł z bazy wiedzy
- **Sekcja** — opcjonalny anchor do konkretnej sekcji wpisu
- **Treść** — opcjonalny krótki tekst HTML wyświetlany w widgecie
- **Aktywny** — czy helplink jest widoczny (nieaktywne tworzone są automatycznie)

## Automatyczne tworzenie

Gdy widget żąda helplinku, którego nie ma w bazie — system automatycznie tworzy go jako nieaktywny. Dzięki temu widać jakie klucze są używane w aplikacji i można je później przypisać do artykułów.

## Statystyki

Każdy helplink śledzi:

- **Liczba otwarć** — ile razy widget go pobrał
- **Liczba kliknięć** — ile razy użytkownik kliknął w link

## Wielojęzyczność

Widget automatycznie szuka helplinku w odpowiedniej wersji językowej bazy wiedzy. Jeśli nie znajdzie — wraca do wersji domyślnej.

## Testowanie

Z poziomu desku bazy wiedzy można wyświetlić listę helplinków do testowania — sprawdzić które klucze mają przypisane wpisy.

---

## API

### Ogólne API

# Intum API

Dokumentacja API platformy [Intum](https://intum.pl) - system operacyjny firmy.

## Host

Host jest zawsze taki sam jak adres konta: `xxxx.intum.com` lub `xxx.intum.pl` (w zależności od ustawień konta)

## Autoryzacja

Wszystkie requesty API wymagają `api_token`:
- header: `Authorization: Bearer TOKEN`

Token możesz wygenerować w **Ustawienia Konta** → **Tokeny API**

## 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**)

## Pola helplink

| 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ź:
```json
{
  "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

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