Oficjalna dokumentacja API SubiektBridge ujrzała światło dzienne. Pod adresem subiektbridge.pl/dokumentacja-api/#przeglad udostępniliśmy kompletny przewodnik po lokalnym interfejsie REST, który rewolucjonizuje sposób, w jaki systemy zewnętrzne, sklepy e-commerce oraz platformy SaaS komunikują się ze stacją Subiekt Nexo.
Zamiast pisać własne, niestabilne agenty Windows, walczyć z bibliotekami COM Sfery czy ryzykować uszkodzenie bazy danych, deweloperzy otrzymują uporządkowane, nowoczesne środowisko programistyczne działające w architekturze /api/v1/.
Co dokładnie znajdziesz w nowej dokumentacji i jak z niej efektywnie korzystać? Przedstawiamy szczegółowy przegląd techniczny.
Dwa filary architektury: Hybrydowy Odczyt i Zapis
Nowoczesna integracja systemów ERP wymaga bezkompromisowej wydajności. Dlatego dokumentacja API SubiektBridge opisuje unikalne podejście do procesowania danych, które dzieli operacje na dwa niezależne strumienie:
1. Ultra-szybki Odczyt (SQL)
Pobieranie danych o kontrahentach, katalogu asortymentu, słownikach, stanach magazynowych oraz szczegółach dokumentów odbywa się bezpośrednio przez zoptymalizowane kwerendy SQL Server. Gwarantuje to błyskawiczne działanie interfejsu użytkownika (UI) w zewnętrznych aplikacjach oraz sprawną synchronizację masową bez obciążania zasobów systemowych.
2. Bezpieczny Zapis (Sfera)
Tworzenie i modyfikacja obiektów biznesowych (w tym dokumentów handlowych i magazynowych takich jak ZK, FS, FZ, PZ, PW czy WZ) realizowane są wyłącznie poprzez oficjalny silnik Sfera Nexo. Oznacza to, że każda operacja zapisu przechodzi przez pełną walidację logiki biznesowej InsERT – system automatycznie pilnuje numeracji, rezerwacji towarów oraz wyliczania podatków, eliminując ryzyko błędów w bazie.
Domeny API: Pełne pokrycie procesów ERP
Dostępne w dokumentacji endpointy zostały logicznie podzielone na kluczowe domeny biznesowe, co ułatwia mapowanie procesów w aplikacjach zewnętrznych:
- System i diagnostyka: Narzędzia do monitorowania kondycji połączenia i statusu agenta.
- Kontrahenci: Zarządzanie bazą klientów (tworzenie, edycja, wyszukiwanie).
- Asortyment: Pełna kartoteka towarów, usług oraz kompletów.
- Słowniki: Dostęp do danych pomocniczych, takich jak formy płatności czy kategorie dokumentów.
- Magazyny i stany: Informacje o dostępności towarów na poszczególnych magazynach w czasie rzeczywistym.
- Dokumenty: Pełna obsługa zamówień i faktur (w tym automatyczne przekształcanie dokumentów).
- Inwentaryzacja: Moduły wspierające kontrolę i sprostowania stanów magazynowych.
Jak czytać tę dokumentację? Przewodnik dla Dewelopera
Aby maksymalnie przyspieszyć proces wdrożenia, dokumentacja została ustrukturyzowana w intuicyjny sposób i jest w całości dostępna w języku polskim:
- Uwierzytelnianie: Szczegółowy opis zabezpieczeń opartych na nagłówkach HMAC, które gwarantują bezpieczne szyfrowanie żądań poza środowiskiem lokalnym (wyjątek stanowią wybrane wywołania typu loopback i zapytania o zdrowie aplikacji – health check).
- Kody odpowiedzi: Kompletny, zunifikowany katalog statusów HTTP wraz z jasnymi wyjaśnieniami ułatwiającymi debugowanie kodu.
- Modele danych: Dokładnie rozpisane typy pól w formacie JSON (stosujące spójną konwencję camelCase, np.
contractorId) z precyzyjnymi opisami ich przeznaczenia. - Endpointy API: Gotowe do skopiowania przykłady żądań (Requests) oraz odpowiedzi (Responses) wraz z przypisanymi statusami dla każdej operacji.
Co ważne dla stabilności Twojego kodu – nazwy pól JSON oraz ścieżki URL stanowią sztywny identyfikator kontraktu API, co oznacza, że pozostają niezmienne przy kolejnych aktualizacjach systemu.
Podsumowanie i Szybki Start
Niezależnie od tego, czy budujesz integrację dla dedykowanego systemu SaaS, dedykowanego e-commerce w React/Next.js, czy automatyzujesz przepływ dokumentów w firmie – dokumentacja API SubiektBridge dostarcza wszystkich niezbędnych narzędzi.
Wejdź na subiektbridge.pl/dokumentacja-api/ i zobacz, jak łatwo połączyć chmurę z lokalną bazą Subiekta za pomocą czystego REST API.