Przejdź do treści
Firmatec API

Połącz iBiznes z własnymi systemami

Firmatec API to interfejs REST do systemu Faktura iBiznes. Udostępnia faktury i zamówienia (odczyt i import), formy płatności, kartotekę klientów i towarów oraz stany magazynowe — na jednym tokenie, z odpowiedziami w formacie JSON.

REST Architektura
JSON Format odpowiedzi
200 Rekordów na stronę
PL/EN Języki komunikatów
Możliwości

Co dziś udostępnia interfejs

Zakres odpowiada aktualnej dokumentacji API — nie opisujemy metod, których jeszcze nie ma.

Faktury — odczyt i import

Lista nieanulowanych faktur ze stronicowaniem, filtrem typu i zakresem dat oraz szczegóły pojedynczego dokumentu. Import z pliku XML Faktura iBiznes, z treści żądania albo z obiektu JSON.

  • Lista i szczegóły dokumentu
  • Import XML lub JSON
  • Odpowiedź 201 po zapisie

Zamówienia — odczyt i import

Lista i szczegóły zamówień ze stronicowaniem i zakresem dat. Import z XML programu Faktura iBiznes albo z JSON. Odpowiedź JSON albo XML nagłówkiem Accept.

  • Lista ze stronicowaniem
  • Import XML lub JSON
  • JSON albo XML w odpowiedzi

Klienci — kartoteka

Lista, odczyt, dodawanie i edycja kart klientów oraz anulowanie i przywrócenie. Słowniki poziomów cen, słów kluczowych, cech, akwizytorów i języka.

  • CRUD kartoteki
  • Anulowanie i przywrócenie
  • Słowniki pomocnicze

Towary — kartoteka

Lista, odczyt, dodawanie i edycja kart towarów, anulowanie i przywrócenie oraz powiązanie zamienników. Słowniki magazynów, jednostek, VAT, grup, producentów i cech.

  • CRUD towarów
  • Zamienniki
  • Słowniki i producenci

Stany i dokumenty magazynowe

Odczyt stanów towarów oraz wystawianie WZ, PW, RW i PZ (wydanie zewnętrzne, przychód/rozchód wewnętrzny, przyjęcie zewnętrzne) ze zmianą ilości na karcie towaru.

  • Lista i szczegóły stanów
  • WZ / PW / RW / PZ (zapis)
  • Aktualizacja STAN

Formy płatności

Lista form płatności z iBiznes oraz edycja nazwy i liczby dni. Te same wartości są używane przy zamówieniach i kartach klientów.

  • Lista form
  • Edycja nazwy i dni
  • Wspólne z zamówieniami

Trzy formaty faktury

Format odpowiedzi wybierany nagłówkiem Accept: JSON do integracji, PDF A4 w układzie Krajowego Systemu e-Faktur albo ta sama wizualizacja jako HTML.

  • JSON dla integracji
  • PDF A4 w układzie KSeF
  • HTML do podglądu

Autoryzacja jednym tokenem

Token jest przypisany do firmy i otwiera dostęp wyłącznie do jej danych. Przekazywany w nagłówku razem z identyfikatorem usługi — bez logowania użytkownika i bez sesji.

  • Token przypisany do firmy
  • Identyfikator usługi w nagłówku
  • Brak dostępu do innych baz
Zasady techniczne

Konkrety, które warto znać przed startem

Wszystkie wartości pochodzą z aktualnej dokumentacji i konfiguracji produkcyjnej.

Stronicowanie Do 200 rekordów na stronę; domyślnie 10. Odpowiedź zawiera numer strony i liczbę rekordów.
Limit żądań Do 240 żądań na minutę. Przekroczenie limitu zwraca kod 429.
Błędy w JSON Jednolity obiekt błędu z kodem i komunikatem. Kody 403, 404, 405, 409 i 422 opisane w dokumentacji.
Język komunikatów Polski lub angielski — wybierany nagłówkiem języka w żądaniu.
Dokumentacja online Opis nagłówków, parametrów, formatów treści i przykłady wywołań w cURL.
Usługa i token Usługę kupuje się i przedłuża samodzielnie. Token generuje się i zmienia na stronie API w Centrum konfiguracji.
Jak zacząć

Od usługi do pierwszego żądania

Integracja nie wymaga zmian w instalacji iBiznes.

Usługa

Usługę integracji kupuje się lub przedłuża samodzielnie na stronie API w Centrum konfiguracji.

Token

Na tej samej stronie generowany jest token; w razie potrzeby wymieniany na nowy.

Pierwsze wywołania

Według dokumentacji pobierana jest lista faktur, zamówień albo towarów i sprawdzany format odpowiedzi.

Produkcja

Uruchamiany jest import dokumentów i cykliczna synchronizacja kartotek w systemie zewnętrznym.

Korzyści

Co zyskujesz, integrując się przez API

API zdejmuje z ludzi przepisywanie dokumentów i kartotek między systemami.

Koniec z eksportem plików „na ręce”

System zewnętrzny pobiera dokumenty, klientów, towary i stany w cyklu, który zostanie ustawiony. Nikt nie generuje raportów i nie przenosi ich przez pulpit.

Dokument zgodny z oryginałem

PDF generowany po stronie Firmatec ma układ Krajowego Systemu e-Faktur. Nie trzeba budować własnego wydruku, który trzeba pilnować przy zmianie przepisów.

Jeden interfejs dla wielu systemów

Sklep, hurtownia, WMS albo aplikacja handlowca korzystają z tego samego API i tego samego formatu danych.

Kontrolowany dostęp

Token dotyczy jednej firmy i jednej usługi. Odebranie dostępu to wycofanie tokena, a nie zmiana haseł użytkowników.

Zbudowane na platformie

Integracje, które już działają

Poniżej połączenia utrzymywane przez Firmatec na tej samej platformie. Pokazują, jaki zakres integracji jest realny.

Shoper Kategorie, produkty, zamówienia, stany magazynowe, klienci i płatności.
Baselinker Zamówienia, statusy, magazyny i import produktów.
Allegro Odczyt ofert sprzedawcy oraz autoresponder wiadomości i zgłoszeń.
InPost ShipX Tworzenie przesyłek i pobieranie punktów odbioru.
KSeF Wysyłka i odbiór faktur, autokontrola zakupów oraz wizualizacja dokumentu.
Faktura iBiznes Baza źródłowa: faktury, zamówienia, kontrahenci i towary.
W przygotowaniu

Planowany rozwój interfejsu

Zakres poniżej nie jest jeszcze dostępny — planowany w kolejnych wersjach API.

  • Paragony jako osobny zasób interfejsu
  • Szerszy zakres zapisu zamówień
  • Powiadomienia o zmianach danych po stronie iBiznes

Zbuduj integrację na Firmatec API

Dokumentacja jest publiczna — sprawdź nagłówki, parametry i przykłady wywołań. Usługę i token ustawiasz samodzielnie na stronie API w Centrum konfiguracji.