API

Przez interfejs programistyczny (API) inne programy uzyskują dostęp do DocSecBox. Na tej stronie widzisz adres interfejsu, ustalasz, skąd dozwolony jest dostęp, i rejestrujesz aplikacje, które mogą z niego korzystać.

Dodatkowy moduł płatny

Dostęp API to płatny moduł dodatkowy. Bez tego modułu w Ustawienia › Aplikacja nie ma pozycji API. Czy moduł jest odblokowany, pokazuje strona Licencja.

Tylko dla administratorów

Tę stronę widzą tylko administratorzy. Jeśli na stronie Role włączona jest opcja Tylko superadministrator może dopasować ustawienia programu, widzą ją tylko superadministratorzy.

Adres interfejsu

Karta Interfejs podaje w polu Podstawowy URL interfejsu HTTP REST adres, pod którym inne programy łączą się z API. Link Dokumentacja API otwiera opis interfejsu. Pełną specyfikację otrzymasz na żądanie od operatora Twojej instancji DocSecBox lub od producenta.

Zezwalanie na dostęp

API przyjmuje tylko żądania z miejsc, na które zezwoliłeś. Obie opcje są fabrycznie wyłączone. Dopóki obie są wyłączone, API odrzuca każde żądanie, a strona to sygnalizuje.

1. Otwórz Ustawienia › Aplikacja › API.
2. W karcie Ustawienia dostępu do API zaznacz jedną lub obie opcje: Dozwolony dostęp z obszaru prywatnych adresów IP i Dozwolony dostęp z obszaru publicznych adresów IP.
3. Kliknij Zapisz ustawienia.

Decyduje adres, z którego przychodzi żądanie. Wywołanie z samego serwera nie jest uznawane ani za wewnętrzne, ani za zewnętrzne. Żadna z obu opcji go nie odrzuca.

Rejestrowanie aplikacji

Każdy program, który korzysta z API, rejestrujesz jako aplikację. Przy tym decydujesz, którzy użytkownicy otrzymają do niej klucz.

1. W karcie Aplikacje API kliknij Dodaj aplikację.
2. W oknie dialogowym Dodaj aplikację API wpisz nazwę w polu Nazwa aplikacji.
3. Na liście użytkowników zaznacz konta, które mają otrzymać klucz. Przy długich listach pomaga pole Szukaj użytkownika....
4. Kliknij Zapisz.

Przy zapisie każde zaznaczone konto otrzymuje klucz. Jeśli później usuniesz zaznaczenie, klucz tego konta zostanie wycofany. Klucz widzi tylko sam użytkownik, w profilu w sekcji Klucze dla aplikacji zewnętrznych. Na tej stronie nigdy nie jest wyświetlany.

Lista aplikacji pokazuje w każdym wierszu Nazwa, liczbę kont w kolumnie Użytkownicy z kluczem oraz Status: Aktywna, Aktywna do z datą lub Wyłączona. Przyciskiem Edytuj zmieniasz aplikację w oknie dialogowym Edytuj aplikację API.

Wycofywanie aplikacji z użycia

Aplikacji nie można usunąć. Wycofujesz ją z użycia za pomocą daty:

1. W wierszu aplikacji kliknij Edytuj.
2. Zaznacz Wyłącz od określonej daty i wybierz datę w polu Wyłączone od.
3. Kliknij Zapisz.

Do tej daty klucze użytkowników pozostają ważne.