Zadzwoń

Integracje REST API

Ewidencja Faktur udostępnia własne REST API, czyli sposób, w jaki inne programy mogą automatycznie pobierać dane z systemu bez logowania i ręcznego klikania. Twój program księgowy, system ERP albo własne narzędzie sięga po faktury i informacje o akceptacji wtedy, kiedy ich potrzebuje. Integracja dzieje się w tle, bez eksportowania plików ręcznie.

Wprowadzenie

API to most między Ewidencją Faktur a Twoim systemem.

Zamiast eksportować pliki ręcznie i wgrywać je gdzieś indziej, integracja dzieje się sama, w tle, według harmonogramu.

To właśnie na tym API opiera się EF Connector, który łączy Ewidencję Faktur z Comarch ERP Optima. Tym samym kanałem podłączysz inne systemy księgowe albo własne narzędzia.

Ewidencja Faktur
faktury KSeF + obieg akceptacji
Zewnętrzny system
FK, ERP albo własne
Most
REST API
HTTPS · podpisane żądania · pełne uprawnienia po stronie właściciela
Do czego służy

Trzy operacje, na których stoi cała integracja

Pobierasz dokumenty, pobierasz informacje o ich obróbce, potwierdzasz odbiór. Reszta to harmonogram.

01 / Plik XML

Pobieranie plików XML faktur

Oryginalne dokumenty z KSeF, gotowe do zaksięgowania w programie finansowo-księgowym. Bez utraty żadnego pola, bez konwersji.

GET/api/invoices/9923/xml
Authorization: Bearer ef_2026_*** 200 OK · faktura.xml (12 KB)
02 / Statusy

Pobieranie statusów i opisów

Czy faktura została zaakceptowana czy odrzucona, jaki nadano jej opis, kto podjął decyzję i kiedy. Komplet kontekstu z obiegu.

GET/api/invoices?status=accepted
Accept: application/json 200 OK · { "count": 14, ... }
03 / Potwierdzenie

Potwierdzanie pobrania

System odbierający oznacza, że przetworzył dane. Przy kolejnym zapytaniu dostanie wyłącznie nowe, jeszcze niepobrane pozycje.

POST/api/invoices/9923/ack
Content-Type: application/json 204 No Content · oznaczono
Klucze dostępu

Klucz API to dane logowania dla programu, nie dla człowieka.

Integracja zaczyna się od wygenerowania klucza w zakładce Firma → API. Tworząc klucz, ustalasz dokładnie, co wolno systemowi, który go używa.

Jeden klucz może obsługiwać jedną lub wiele firm, co jest wygodne dla biur rachunkowych i grup kapitałowych.

Nazwa · opis pomagający rozpoznać, do czego klucz służy
Uprawnienia · czy klucz pobiera pliki XML, statusy, czy jedno i drugie
Zakres statusów · wszystkie, tylko zaakceptowane albo tylko odrzucone
Blokada po pobraniu · zabezpieczenie przed dwukrotnym przetworzeniem
Lista dozwolonych adresów IP · ograniczenie do konkretnego serwera
Nowy klucz API Firma → API
Nazwanp. „Klient FK · integracja”
Uprawnienia
Pliki XML fakturGET /xml
Statusy i opisyGET /status
Zakres statusów
Wszystkie
Tylko zaakceptowane
Tylko odrzucone
Blokada po pobraniu
Dozwolone IPjedno na linię, puste = bez ograniczeń
Co widać w panelu

Lista kluczy i dziennik pobrań

Pełen wgląd w to, kto sięga po dane Twojej firmy. Każdy klucz, każde użycie, każda pobrana paczka.

Firma → API
3 aktywne klucze · ostatnie pobranie 4 min temu
KluczUprawnieniaDozwolone IPOstatnie użycie
Klient FK · integracja
ef_2026_a8f2…7c
XMLSTATUSY
2 adresy
185.62.198.42, …
4 min temu2026-05-28 14:32
Biuro Rachunkowe ABC
ef_2026_4d91…ec
XMLSTATUSY
brak ograniczeń
1 h temu2026-05-28 13:18
Wewnętrzny ERP · raporty
ef_2026_b53c…91
STATUSY
1 adres
10.0.4.21
wczoraj2026-05-27 22:00
Dziennik pobrań
14:32:18Klient FK · integracjaGET/invoices/xml14 pobrane
14:32:14Klient FK · integracjaGET/invoices/status14 pobrane
14:32:14Klient FK · integracjaPOST/invoices/ack14 potwierdzone
13:18:02Biuro Rachunkowe ABCGET/invoices/status43 pobrane
Bezpieczeństwo

Sześć warstw ochrony danych firmy

API zaprojektowane od pierwszej linii kodu z myślą o tym, żeby tylko właściciel danych decydował, kto się do nich dostaje.

Szyfrowane połączenie

Komunikacja działa wyłącznie przez HTTPS. Bez wyjątków, bez fallbacków na nieszyfrowane.

Podpisywane żądania

Każde zapytanie jest cyfrowo podpisywane. Hasło nigdy nie wędruje przez sieć, system sprawdza tylko zgodność podpisu.

Ochrona przed powtórzeniem

Żądanie jest ważne tylko przez kilka minut. Uniemożliwia to przechwycenie i ponowne użycie tego samego pakietu.

Ograniczenie adresów IP

Opcjonalne zawężenie dostępu do wskazanych adresów. Klucz wykradziony, ale używany spoza listy, zostanie odrzucony.

Limit zapytań

System ogranicza liczbę zapytań na minutę. Chroni to przed nadużyciami i przeciążeniem.

Pełne uprawnienia po stronie właściciela

To Ty decydujesz, jakie dane i w jakim zakresie udostępniasz. Klucz nigdy nie ma więcej uprawnień, niż mu nadano.

Typowy scenariusz

Cykl, który dzieje się sam

Faktury trafiają do EF, ktoś je akceptuje, zewnętrzny system pobiera, przetwarza, potwierdza. Powtarzaj według harmonogramu.

Krok 1

Faktury w Ewidencji Faktur

Pobierają się z KSeF, przechodzą przez obieg akceptacji. Ktoś je opisuje, ktoś zatwierdza.

Krok 2

Zewnętrzny system odpytuje API

Program księgowy regularnie sprawdza, czy są nowe zaakceptowane faktury. Co kilka minut, co godzinę, zależnie od ustawień.

Krok 3

Pobiera XML i metadane

Razem z plikami otrzymuje informacje o akceptacji, opisie i osobie decydującej. Komplet danych do zaksięgowania.

Krok 4

Potwierdza pobranie

Przy następnym połączeniu dostanie tylko kolejne, nowe dokumenty. Nic nie pobierze się dwa razy.

Dla kogo

Komu się przyda integracja przez API

Wszędzie, gdzie chcesz wymienić ręczny eksport na automatyczny przepływ danych.

Firma

Firmy z systemem FK lub ERP

Chcesz zautomatyzować przepływ faktur z Ewidencji Faktur do swojego oprogramowania księgowego. Bez ręcznych eksportów, bez przeklepywania, bez podwójnej pracy.

Biuro rachunkowe

Biura obsługujące wiele firm

Jedną integracją obejmujesz wszystkich klientów. Każda spółka ma własne ustawienia, własne klucze, własny harmonogram, ale infrastruktura jest jedna.

IT i integratorzy

Zespoły IT i integratorzy

Budujesz własne połączenia z Ewidencją Faktur: dashboardy, raporty, custom workflow. REST API z czystą dokumentacją i jasnym kontraktem.

FAQ

Najczęstsze pytania o REST API

Nie znalazłeś odpowiedzi? Napisz do nas.
Odpisujemy w ciągu kilku godzin.

01.Czy klucz API to to samo co moje hasło do Ewidencji Faktur?
Nie. Klucz API to oddzielne poświadczenie dla programu, nie dla człowieka. Twoje hasło zostaje do logowania w przeglądarce. Klucz API używany jest tylko przez integrację, ma swój własny zakres uprawnień i można go w każdej chwili unieważnić bez wpływu na Twoje konto.
02.Czy mogę nadać klucz tylko do XML, bez statusów?
Tak. Uprawnienia ustawiasz osobno dla pobierania XML i osobno dla pobierania statusów. Możesz nadać jedno z nich, drugie albo oba. Decydujesz Ty, klucz nigdy nie ma więcej, niż mu dałeś.
03.Czy jeden klucz może obsługiwać wiele firm?
Tak. Każdy klucz może obejmować jedną lub wiele firm. Szczególnie wygodne dla biur rachunkowych i grup kapitałowych, które jedną integracją obsługują wiele podmiotów. Każda firma zachowuje przy tym własne ustawienia dotyczące zakresu udostępnianych danych.
04.Co się dzieje, jeśli klucz wpadnie w niepowołane ręce?
Pierwsza linia obrony to lista dozwolonych IP: klucz używany spoza wskazanych adresów zostanie odrzucony. Druga linia to ograniczone uprawnienia: klucz nie pozwala na nic poza tym, co mu nadałeś. Trzecia, najprostsza, to natychmiastowe unieważnienie w panelu. Po tym kliknięciu klucz przestaje działać w sekundę.
05.Czy dziennik pobrań pokazuje, kto pobrał dane?
Pokazuje, którym kluczem pobrano dane, kiedy, jaką operację wykonano i ile rekordów przekazano. Jeśli dla danego klucza ustawiłeś listę IP, w razie potrzeby można też namierzyć źródło konkretnego zapytania. To gwarantuje pełną kontrolę nad tym, kto i kiedy sięga po dane firmy.
06.Gdzie znajdę dokumentację techniczną API?
Szczegółowy opis kluczy, uprawnień, blokad i synchronizacji znajdziesz w pomocy aplikacji Ewidencja Faktur, w sekcji poświęconej integracji. Tam krok po kroku opisane jest, jak utworzyć klucz, jak nadać mu uprawnienia i jak działa pobieranie faktur oraz statusów przez systemy zewnętrzne.
Podłącz własny system

Faktura w KSeF. Status w EF. Dane w Twoim ERP.

Załóż konto, wygeneruj klucz API, podłącz integrację. Bez ręcznych eksportów, bez przegrywania plików.

Plan START bezpłatny
HTTPS i podpisane żądania
Wsparcie wielu firm