Overview

Czym jest Public API KSeFCore dla integratorów i jak działa model asynchroniczny

Cel integratora

KSeFCore udostępnia Public API do integracji system-system: wysyłki faktur XML oraz synchronizacji i pobierania dokumentów.

Zakres tej dokumentacji (integrator)

Dokumentacja integracyjna dotyczy wyłącznie endpointów /api/v1/* autoryzowanych nagłówkiem X-API-Token:

• /api/v1/me
• /api/v1/submissions*
• /api/v1/documents*
• /api/v1/webhooks*
• /api/v1/webhooks/deliveries*

Opcjonalnie (operacyjnie): /health.

Kluczowe własności

• Asynchroniczność: POST /api/v1/submissions przyjmuje zgłoszenie, ale nie oznacza finalnego wyniku.
• Webhook-driven: webhooki są podstawowym kanałem informacji o zmianach stanu.
• At-least-once: webhook może się powtórzyć — wymagana deduplikacja po event_id.

Poza zakresem

Ta dokumentacja integracyjna nie opisuje:

• integracji człowiek-system (funkcje workflow i magic linki)
• mechanizmów logowania/sesji do KSeF
• UI panelu administracyjnego
• endpointów nieprzeznaczonych dla integratorów