Instancje API (API Instance) umożliwiają przekazywanie danych między wieloma instancjami.
Konfiguracja
Opcje:
- Name - nazwa definicji
- Active - flaga aktywności
- System - flaga systemowa
- Url - protokół i adres WWW serwera, np. https://www.twojastrona.pl/api/
- Login - login użytkownika na instancji udostępniającej dane
- Password - hasło użytkownika
Wykorzystanie
Wybór źródła danych wybiera się w konfiguracjach poszczególnych komponentów. W polu Data source należy zmienić domyślną opcję Connection String na API Instance, a następnie wybrać wcześniej skonfigurowaną definicję.
Do czego służą instancje API
Instancje API (API Instance) pozwalają przekazywać dane między wieloma instancjami platformy StudioSystem RS lub między platformą a systemem zewnętrznym. Zamiast odczytywać dane wyłącznie z lokalnej bazy, komponent może pobrać je z innej instancji przez zdefiniowane połączenie.
Konfiguracja definicji
- Name - nazwa definicji używana przy wyborze źródła danych.
- Active - flaga aktywności; nieaktywne definicje nie pojawiają się na listach wyboru.
- System - flaga elementu systemowego konfiguracji.
- Url - protokół i adres serwera udostępniającego dane, na przykład
https://twojastrona.pl/api/. - Login i Password - dane użytkownika na instancji udostępniającej dane.
Jak wskazać instancję API jako źródło danych
W konfiguracji komponentu (na przykład Data Grid lub Photo Grid) w polu Data source zmień domyślną opcję Connection String na API Instance, a następnie wybierz wcześniej przygotowaną definicję. Dalsza konstrukcja zapytania pozostaje bez zmian.
Bezpieczeństwo i utrzymanie definicji
Login i hasło zapisane w definicji służą do uwierzytelnienia na instancji udostępniającej dane, dlatego zakładaj po jej stronie konto techniczne o minimalnym zakresie uprawnień - tylko do odczytu potrzebnych zasobów. Adres w polu Url powinien wskazywać punkt wejścia API zakończony ukośnikiem, na przykład https://twojastrona.pl/api/.
Flaga Active pozwala tymczasowo wyłączyć definicję bez jej usuwania - przydaje się przy pracach serwisowych po stronie systemu źródłowego. Po zmianie adresu lub danych logowania sprawdź wszystkie komponenty, które korzystają z tej definicji jako Data source, bo błędne połączenie ujawni się dopiero przy próbie odczytu danych przez użytkownika.