bs4 API umożliwia zewnętrznemu programowi odczyt i zmianę danych oraz wywoływanie wybranych działań w konkretnej instalacji BS4 Core. Przed napisaniem integracji administrator musi przygotować konektor i jawnie udostępnić potrzebne operacje.
Warunki uruchomienia #
Usługa wymaga odpowiedniej licencji; włączenie funkcji uzgodnij z obsługą BS4. Adres instalacji musi być osiągalny ze środowiska, w którym działa integracja. W instalacji on-premises sprawdź domenę, podfolder, konfigurację serwera WWW oraz reguły dostępu do sieci. Publiczne otwieranie dostępu nie jest potrzebne, jeżeli integracja działa wewnątrz tej samej sieci lub przez uzgodniony VPN.
Utworzenie konektora #
Otwórz menu „Opcje” i wybierz opcję menu „Administrator”. W kartotece Administrator wybierz przycisk „Superadministrator”, a następnie w sekcji „Integracje” kliknij odnośnik „Konektory”.
- Kliknij przycisk „Dodaj nowe”. Wypełnij pole „Nazwa”, w polu „Typ” wybierz „bs4-API”, następnie kliknij przycisk „Dodaj i edytuj…”.
- W ustawieniach konektora włącz pole „Czy konektor aktywny”.
- Ustaw dostęp do klas, pól, zestawień i triggerów zgodnie z zakresem integracji. Zapisz ustawienia.
- Kliknij przycisk „Generuj nowy token” i przekaż token do bezpiecznej konfiguracji programu integracyjnego. W żądaniach używaj nagłówka Authorization: Bearer TOKEN.
Jawne listy dostępu #
| Ustawienie | Zakres |
|---|---|
| klasy factory API read | klasy dopuszczone do odczytu. Osobno wskaż pola w ustawieniu „Zmienne admina API read”. |
| klasy factory API create | klasy, w których API może dodawać obiekty. |
| klasy factory API update | klasy dopuszczone do aktualizacji. Pola aktualizacji określa „Zmienne admina API update”. |
| klasy factory API delete | klasy dopuszczone do usuwania obiektów. |
| Dozwolone zestawienia | Strony zestawień dostępne przez exec/report. |
| Dozwolone triggery | Triggery dostępne przez exec/runtrigger. |
Pusta lista nie udostępnia wszystkich klas ani pól. Dostęp do klasy nie oznacza automatycznego dostępu do wszystkich jej pól. Listy pól w formularzu zależą od wybranych klas.
Dodawanie i aktualizacja mają różną kontrolę pól. Aktualny POST tworzący obiekt sprawdza uprawnienie create do klasy. Lista pól update ogranicza PUT; nie stanowi osobnej listy pól dopuszczonych przy tworzeniu. Przy nadawaniu create uwzględnij tę różnicę.
Pomoc dla developera #
W formularzu edycji konektora znajdziesz pomoc dla developera: diagnostykę konfiguracji oraz adresy, aliasy klas i pól właściwe dla tej instalacji. Korzystaj z tych aliasów w kodzie integracji. Nazwa wyświetlana użytkownikowi, nazwa kolumny SQL i alias API mogą być różne.
Token i właściciel #
Regenerowanie tokena zmienia dane dostępowe integracji; zaktualizuj jej konfigurację. Wyłączenie aktywności konektora blokuje kolejne żądania API. pole „Właściciel konektora” nie zastępuje jawnych list dostępu API i nie należy interpretować go tak jak wymogu superadministratora dla MCP.
Kolejne kroki: wywołania CRUD, wykonywanie triggerów i diagnostyka.
