Dokumentacja

Szybki start i zasady uploadu.

Ta podstrona opisuje przykładowy proces integracji (UI + API) dla: bankowości, ubezpieczeń i e-commerce.

Wymagania plików

  • Formaty: PDF, PNG/JPG, DOCX, ZIP
  • Rozmiar: do 100 MB / plik (konfigurowalne)
  • Nazwy: bez znaków specjalnych, preferuj kebab-case + identyfikator (np. wyciag-2026-03.pdf)
  • ZIP: spłaszczona struktura lub katalogi (wg konfiguracji)

Proces publikacji

  1. Create — tworzysz publikację (np. dla klienta i zdarzenia: umowa/polisa/zamówienie).
  2. Upload — dodajesz 1..N plików.
  3. Finalize — zamykasz publikację i dostajesz link.
  4. Notify — webhook/zdarzenie do Twojego systemu.

Przykładowe endpointy (koncepcja)

POST /api/publications
POST /api/publications/{id}/files
POST /api/publications/{id}/finalize
GET  /api/publications/{id}
GET  /api/publications/{id}/download

Wersja demonstracyjna strony nie zawiera backendu — to miejsce na Twoją właściwą dokumentację lub linki do Swaggera.

Webhooks (przykład)

{
  "type": "publication.finalized",
  "publicationId": "pub_123",
  "customerId": "cust_456",
  "externalRef": "order_987 / policy_123 / contract_555",
  "documentType": "statement / policy / invoice",
  "downloadUrl": "https://...",
  "publishedAt": "2026-04-16T10:15:00Z"
}

Typy dokumentów (przykłady)

Bank

Wyciągi, potwierdzenia transakcji, taryfy opłat, komunikaty o zmianach.

Ubezpieczenia

Polisy, OWU, aneksy, decyzje, harmonogramy płatności.

E-commerce

Faktury/korekty, regulaminy, potwierdzenia zamówień, zwroty i reklamacje.