Workflowy to gotowe scenariusze, które łączą endpointy API KSeF z operacjami lokalnymi (kryptografia, ZIP, upload/download partów, polling statusów).
W TypeScript są dostępne pod client.workflows.
- Uwierzytelnianie (token KSeF / XAdES)
- Sesja interaktywna (open -> send -> close -> UPO)
- Sesja wsadowa (ZIP -> podział -> szyfrowanie -> upload -> close)
- Tryb offline (offline24 / offline / awaryjny)
- Eksport paczek i eksport przyrostowy
- Użyj workflow, gdy chcesz gotowy proces end-to-end z sensownymi domyślnymi ustawieniami.
- Użyj thin API (
client.auth,client.sessions,client.invoices), gdy potrzebujesz pełnej kontroli nad każdym requestem i pollingiem.
- Workflowy sesji, eksportu i offline wymagają ustawionego
accessTokenwauthManager. - Najkrótsza ścieżka to
KsefClient.connect(...), który uruchamia tokenowy workflow auth i zapisuje tokeny. - W przypadku manualnego auth ustaw tokeny przez
client.authManager.setTokens(...).
import { KsefClient } from "ksef-client-typescript";
const client = await KsefClient.connect({
environment: "DEMO",
token: process.env.KSEF_TOKEN!,
context: { type: "Nip", value: process.env.KSEF_NIP ?? "5265877635" },
pollIntervalMs: 2000,
maxAttempts: 90,
});| Potrzeba | Workflow |
|---|---|
Uzyskanie tokenów (accessToken, refreshToken) |
client.workflows.auth.* |
| Wysyłka pojedynczych faktur w sesji online | client.workflows.sessions.online.* |
| Wysyłka paczki faktur jako ZIP | client.workflows.sessions.batch.openUploadAndClose(...) |
Wysyłka faktury z offlineMode=true + instrukcje operacyjne |
client.workflows.offline.* |
| Eksport i obróbka paczek faktur | client.workflows.exports.* |
| Eksport przyrostowy z continuation points | client.workflows.exportsIncremental.run(...) |
- API reference: ../api/README.md
- Praktyczne fragmenty kodu: ../examples/README.md
- Błędy i retry: ../errors.md