Strona główna eFaktúra Narzędzia Dla developerów
Portal developera

Dokumentacja API dla eFaktúra

Dokumentacja integracji obejmująca lookup, walidację, wysyłanie, odbieranie, webhooki i eksport audytowy. Opisuje zalecane podejście do wdrożenia, zasady bezpieczeństwa i scenariusze integracji.

REST API Sandbox-ready Idempotency-first Webhook events Evidence-friendly

Dostępność interfejsów

Dostępne endpointy mogą różnić się w zależności od środowiska i typu wdrożenia. Klucze produkcyjne należą do serwera, nie do przeglądarki. Publiczny frontend nie może wywoływać prywatnych tras produkcyjnych bezpośrednio.

Auth

Bearer + idempotencja

Prywatne klucze API należą do serwera, nie do JS przeglądarki. Wysyłka i ponowienia powinny używać Idempotency-Key.

Authorization · Idempotency-Key
Lifecycle

Wyślij + odbierz + przetwórz

Endpointy uwzględniają nie tylko wysyłkę, ale też odbiór, akceptacje, kody odpowiedzi, pakiety dowodowe i przepływ archiwizacji.

Wyślij · Odbierz · Evidence
DX

Sandbox i quickstarty

Integrator potrzebuje krótkiego quickstartu, przykładów payloadu, reguł retry, webhooków i jasnego rozróżnienia między trybem testowym a produkcyjnym.

Docs · Przykłady · Webhooki

Profil integracji enterprise

Dla klientów enterprise ważny jest w pełni zautomatyzowany przepływ: system przyjmuje feed, waliduje go, konwertuje, wysyła i zwraca finalne artefakty z powrotem do archiwum lub ERP.

Integracja M2M REST API Zwrot przez webhook

Feed, formaty i ICD

Integracja uwzględnia feed JSON/XML, przetwarzanie wsadowe i bezpieczne kanały jak SFTP. Interface Control Document może mieć formę specyfikacji OpenAPI/Swagger uzupełnionej o mapowanie i reguły retry.

JSON / XML Batch / SFTP ICD / OpenAPI

Fail flow i retry

Przy błędzie system powinien zwrócić szczegółowy powód, rule ID, węzeł XML i zalecaną poprawkę. Źródłem poprawki pozostaje system źródłowy, a eFaktúra centrum zwraca wynik przez webhook.

rule_id + detail Retry workflow Audit trail

Finalne artefakty i portal

Klienci enterprise często potrzebują odzyskać finalne XML i PDF, mieć portal do przeglądu przetworzonych faktur i przygotować własny szablon PDF zgodny z brandingiem.

Szablon PDF Zwrot finalnego XML/PDF Portal / viewer
ICD

ICD & OpenAPI

Kontrakt dla feedu, mapowania, katalogu błędów, wersjonowania i listy kontrolnej dla zespołów enterprise.

Otwórz ICD →
Events

Webhook Contract

Cykl życia dostawy, payloady callback, model podpisu, retries i kolejność zdarzeń.

Otwórz webhooki →
Artifacts

Artifact Return & PDF

Zwrot finalnego XML/PDF, pakiet niestandardowego szablonu i przekazanie do archiwum w systemie klienta.

Otwórz warstwę artefaktów →
Env

Sandbox vs Produkcja

Lista kontrolna promocji, payloady testowe, zabezpieczenia idempotencji i reguły cutover przed startem produkcyjnym.

Otwórz tryby →
Rules

Error Catalog

Rule ID, waga, ścieżka XML, wskazówki naprawcze i model właściciela dla triage enterprise.

Otwórz katalog błędów →
Batch

SFTP & Batch Onboarding

Konwencje nazewnictwa, manifesty, pliki ACK, częściowy retry i identyfikowalność dla feedów korporacyjnych.

Otwórz batch onboarding →
Trust

Security & Trust Center

Rezydencja danych w UE, logi audytowe, retencja i model operacyjny enterprise do przeglądu technicznego.

Otwórz trust center →
Identity

Enterprise Identity

SSO, cykl życia i zarządzanie rolami dla tenantów korporacyjnych i zespołów integracyjnych.

Otwórz warstwę identity →
Pricing

API & Enterprise Pricing

API pay-as-you-go, plany dla księgowych i middleware enterprise w jednym modelu komercyjnym.

Otwórz cennik →
RBAC

Access Control

Rozdzielenie uprawnień admina, księgowego i developera, w tym klucze API i role audytowe.

Otwórz RBAC →
Connectors

Integrations

Priorytetowa lista systemów dla rynku słowackiego ze statusem kompatybilności. Import działa już z POHODA XML, eksportami KROS, Money/MRP CSV i ISDOC; kolejne bezpośrednie konektory są dodawane stopniowo.

Otwórz integracje →
Security

Security Baseline

Techniczna baza dla nagłówków edge, CORS, kontroli payloadu, auth i hardeningu enterprise.

Otwórz security baseline →
Ops

Status & Observability

Strona statusu, log dostaw webhooków, correlation ID i raportowanie incydentów dla wsparcia enterprise.

Otwórz observability →
Audit

Audit Export

Pakiet e-Discovery dla klientów potrzebujących eksportu XML/PDF/log za dany okres.

Otwórz audit export →
Automation

Automation Suite

Reguły, dopasowanie PO, spory i smart intake dla bardziej zaawansowanych scenariuszy automatyzacji.

Otwórz automation suite →
Network

Global Network

Factur-X, clearance i roaming jako kierunek wielokrajowy dla kolejnych integracji.

Otwórz warstwę sieci →
GET /api/peppol-lookup/:participantId

Lookup partnera w formacie 0245:2020123456. Wynik: rejestracja, nazwa, obsługiwane dokumenty, status gotowości i zalecany kanał.

Live API / weryfikacjaOnboarding partnera
POST /api/validate

Walidacja XML zwraca rule_id, wagę problemu i zalecenie naprawy. W lokalnym przeglądzie zawsze powinno być jasno oznaczone, że nie jest to wynik produkcyjny.

WalidacjaLokalny przegląd oddzielnie
POST /api/convert

Excel, CSV lub przygotowane eksporty na wejściu, ZIP z gotowymi XML lub raportem wsadowym na wyjściu. Odpowiednie dla stopniowego przejścia bez nowego ERP.

KonwersjaKontrola wymagana przy niepewnym wejściu
POST /api/send

Przygotowanie i wysyłka dokumentu przez podłączonego certyfikowanego partnera, z naciskiem na Idempotency-Key, ID transmisji, evidence i kolejne zdarzenia response.

Przez podłączonego certyfikowanego partneraPo aktywacji połączenia
GET /api/messages/:invoiceId

Przegląd ACK, NACK, odrzuceń i innych zdarzeń wraz ze znaczeniem biznesowym i osią czasu przetwarzania.

Oś czasu zdarzeńMożliwy lokalny przegląd
GET /api/evidence/:invoiceId

Pakiet do audytu lub kontroli wewnętrznej: payload, podsumowanie walidacji, zdarzenia response, wersja reguł i oś czasu przetwarzania.

Audit / eksportPomocniczy eksport lokalny

Quickstart

Poniższe przykłady służą jako wzorzec sandboxa lub integracji server-side. Produkcyjny URL, autoryzacja i dostępne endpointy zależą od wybranego wdrożenia.

curl -X POST /api/validate \ -H "Authorization: Bearer $API_KEY" \ -F "files[]=@faktura001.xml"
const res = await fetch("https://api.verifyeu.com/api/peppol-lookup/0245:2020123456", { headers: { Authorization: "Bearer " + process.env.API_KEY } });
requests.post( "https://api.verifyeu.com/api/send", headers={ "Authorization": "Bearer " + API_KEY, "Idempotency-Key": "invoice-2026-001" }, files={"xml_file": open("invoice.xml", "rb")} )

Auth, sandbox i reguły retry

Temat
Reguła
Wpływ
Klucze API
Klucz należy do środowiska server-side. Frontend powinien wywoływać własny backend lub proxy, nie publiczny JS przeglądarki.
Bezpieczeństwo
Dostępność
Przed integracją potwierdź, które trasy są dostępne na produkcji, a które służą tylko do testów lub lokalnego przeglądu.
Zaufanie
Sandbox
Pierwsze integracje powinny używać demo/mock providera, payloadów testowych i logowania oddzielonego od produkcji.
Niższe ryzyko
Idempotencja
Każda próba przygotowania wysyłki przez podłączonego certyfikowanego partnera powinna mieć stabilny Idempotency-Key. Retry nie może tworzyć duplikatów faktur.
Operacje
Validation gate
Przed /api/send powinien przebiec walidator, a przy błędach dokument powinien zatrzymać się w remediation flow.
Compliance
Evidence
Zapisuj wersję reguł, ID transmisji, oś czasu response i metadane akceptacji dla audit trail.
Audit

Co uzupełnić przy zapytaniach enterprise

Wymaganie
Zalecana odpowiedź produktowa
Warstwa
Feed faktur
REST API jako główny kanał, plus batch lub SFTP dla dużych eksportów korporacyjnych.
M2M
Formaty
JSON/XML na wejściu, konwersja do PEPPOL BIS 3.0 lub SK CIUS wewnątrz warstwy middleware.
Convert
ICD
OpenAPI/Swagger + notatki mapowania + katalog błędów + reguły retry + kontrakt webhook.
DX
Obsługa błędów
Zwracaj rule ID, wagę, węzeł/ścieżkę i wytłumaczalną naprawę; system źródłowy poprawia dane i wysyła ponownie.
Walidator
Finalny PDF/XML
Po walidacji i wysyłce móc zwrócić finalny XML i PDF z powrotem do archiwum klienta przez API lub webhook.
Archiwum
Portal
Połączyć viewer, inbox i audit trail w rzetelny portal dla użytkowników finance i operations.
Portal

Webhook events

Warstwa transportowa potwierdziła dostarczenie do sieci lub odbiorcy.

Odrzucenie transportowe lub biznesowe. Zazwyczaj otwiera remediation flow.

Warunkowa akceptacja, timeout lub konflikt danych workflow.

Dokument został zamknięty i oznaczony do archiwizacji z pakietem evidence.

Finalny XML i PDF są gotowe do zwrotu do wewnętrznego archiwum lub systemu billingowego klienta.

Developer guardrails

Wejścia o niskim zaufaniu powinny przechodzić przez ręczny przegląd, nie autonomiczną wysyłkę.

Peppol ID, numer podatkowy, IBAN i identyfikatory partnera trzeba zwalidować przed batchem.

ACK nie oznacza akceptacji biznesowej. Workflow powinien czekać na kolejne zdarzenie response.

Dla nieprzygotowanego partnera zwróć zalecany kanał, nie tylko komunikat "partner nie znaleziony".