Dostp do danych przy uyciu API ul Wadowicka

Dostęp do danych przy użyciu API ul. Wadowicka 8 a, 30 -415 Kraków tel. : +48 12 425 -06 -25; +48 12 295 -08 -25 www. smallgis. pl

Dostęp do danych przy użyciu API • Czym są interfejsy API • Interfejsy API w systemie SIPAM • Dostępne usługi • Przykłady żądań i odpowiedzi • Autoryzacja dostępu

Interfejsy API • Dostęp do usług REST serwera aplikacji na bazie protokołu HTTP • Najprostsza forma dostępu – przeglądarka internetowa • Mogą być wywoływane za pomocą dowolnego programu lub języka programowania wspierającego obsługę protokołu HTTP

Interfejsy API • Odrębne interfejsy dostępu do danych dla każdego węzła systemu: • Ministerstwo Gospodarki Morskiej i Żeglugi Śródlądowej https: //mgm-local. sipam. gov. pl/service • Urząd Morski w Gdyni https: //umg-local. sipam. gov. pl/service • Urząd Morski w Szczecinie https: //ums-local. sipam. gov. pl/service

Narzędzia i dane dostępne poprzez API • Analiza położenia w strefie przybrzeżnej • Generowanie załączników mapowych • Dokumentacja fotograficzna • Dostęp do dokumentów i danych w prowadzonych rejestrach i ewidencjach • Pobieranie danych i dokumentów

Analiza położenia w strefie przybrzeżnej • Analiza położenia wskazanego obiektu w strefie przybrzeżnej i generowanie pliku w formacie PDF zawierającego raport z analizy • Sekwencja metod: POST /api/identification/coastal_zone/report/generate/read_geom lub POST /api/identification/coastal_zone/report/generate/read_geom/file lub POST /api/identification/coastal_zone/report/generate oraz GET /api/identification/coastal_zone/report/download

POST /api/identification/coastal_zone/report/generate/read_geom Odpowiedź zawiera identyfikator pliku z raportem

GET /api/identification/coastal_zone/report/download W żądaniu przesyłany jest identyfikator pliku z raportem W odpowiedzi przesyłany jest plik PDF z raportem z analizy

Generowanie załączników mapowych • Dodawanie do systemu obiektów przestrzennych, które będą mogły być powiązane z wnioskiem składanym przez interesariusza, oraz przygotowanie załącznika mapowego, który będzie można wydrukować i załączyć do pisma urzędowego • Sekwencja metod: POST /api/map_attachment/generate oraz GET /api/map_attachment/download

POST /api/map_attachment/generate Odpowiedź zawiera identyfikator pliku z załącznikiem mapowym

GET /api/map_attachment/download W żądaniu przesyłany jest identyfikator pliku z załącznikiem mapowym W odpowiedzi przesyłany jest plik PDF z załącznikiem mapowym

Dokumentacja fotograficzna • Dodawanie do systemu SIPAM plików graficznych, które mogą być jednoznacznie powiązane z przestrzenią • Zapis sekwencją metod: POST /api/photographic_documentation/temp/images lub POST /api/photographic_documentation/temp/geotags oraz POST /api/photographic_documentation

POST /api/photographic_documentation/temp/images Odpowiedź zawiera nazwę i ścieżkę do pliku, które należy skopiować do parametrów kolejnej metody

POST /api/photographic_documentation Odpowiedź zawiera informacje o zapisanych obiektach

Dostęp do danych • Dostęp do informacji o tabelach, obiektach i szczegółach obiektów • Sekwencja metod: GET /api/dictionaries/tables GET /api/objects

GET /api/dictionaries/tables Odpowiedź zawiera listę tabel wraz z ich kodami

GET /api/objects Odpowiedź zawiera listę obiektów i ich atrybutów

Dostęp do dokumentów • Dostęp do informacji o dokumentach przechowywanych w systemie • Sekwencja metod: GET /api/dictionaries/documents_table_code GET /api/objects

GET /api/dictionaries/documents_table_code • metoda nie wymaga podawania żadnych parametrów Odpowiedź zawiera kod tabeli przechowującej dokumenty

GET /api/objects Odpowiedź zawiera listę dokumentów i ich atrybutów

Pobieranie załączników • Dostęp do informacji o załącznikach do dokumentów i obiektów oraz pobieranie załączników • Sekwencja metod: GET /api/objects/attachments/{table_code} GET /api/objects/attachments • Metody dostępne tylko dla klientów z odpowiednimi uprawnieniami

GET /api/objects/attachments/{table_code} Odpowiedź zawiera listę załączników

GET /api/objects/attachments W odpowiedzi przesyłany jest plik załącznika

Autoryzacja • Autoryzacja wymaga podania loginu i hasła klienta oraz przesłania otrzymanego z systemu tokenu • Dodatkowo, podczas autoryzacji klienta należy poprzedzić wpisywany token frazą „Bearer ” • Klienci mogą się różnić uprawnieniami • Metody związane z pobieraniem załączników wymagają specjalnych uprawnień dostępu do poszczególnych tematów danych

Dziękuję za uwagę ul. Wadowicka 8 a, 30 -415 Kraków tel. : +48 12 425 -06 -25; +48 12 295 -08 -25 www. smallgis. pl