Interfejs programistyczny aplikacji API (ang. Application Programming Interface) łączy w sobie metody programowania, specyfikacje techniczne i dokumentację, aby umożliwić zarejestrowanym użytkownikom uzyskanie dostępu do danych administracji morskiej. Interfejsy API umożliwiają pobranie i ponowne wykorzystanie udostępnianych danych, w szczególności przez zarejestrowanych użytkowników.

Bazy danych udostępnione za pośrednictwem API

Bazy danych przestrzennych gromadzone w systemie SIPAM zostały udostępnione za pośrednictwem interfejsów API stanowiących implementację protokołu OGC (Web Feature Service). Ponadto udostępnione zostały interfejsy API dla usług wyszukiwania metadanych stanowiących implementacje protokołu CSW.

Interfejsy SPARQL

Repozytorium danych RDF zostało udostępnione za pomocą interfejsu SPARQL (Endpoint SAPRQL). Ze względu na charakter publikowanych danych, zaimplementowana usługa SPARQL jest zgodna z rozszerzeniem GeoSPARQL, rozszerzającym możliwości wykonywania zapytań do usługi z zastosowaniem operatorów przestrzennych.

Dedykowane interfejsy API

Oprócz interfejsów API wykorzystujących międzynarodowe standardy w SIPAM zostały zaprojektowane i wdrożone dedykowane interfejsy dla programistów (API). Interfejsy te pozwalają na gromadzenie i udostępnianie danych przestrzennych specyficznych dla administracji morskiej oraz uzyskiwanie informacji powstałych w wyniku analiz przestrzennych tych danych. Dedykowane interfejsy API zawierają narzędzia związane z zarządzaniem danymi opisowymi, takie jak tabele, zestawienia, dedykowane formularze jak również narzędzia obsługi danych przestrzennych:

• Rejestr dokumentów,
• Załączniki mapowe,
• Informacja dotycząca statusu formalnego strefy przybrzeżnej,
• Dokumentacja fotograficzna.

Do budowy API dedykowanego na potrzeby SIPAM zastosowany został standard REST korzystający z bezpiecznego protokołu HTTPS.

Do skorzystania z części metod udostępnianych za pomocą API jest wymagana autoryzacja i posiadanie odpowiednich uprawnień. W celu uzyskania pełnego dostępu do danych należy wystąpić z wnioskiem o nadanie danych autoryzacyjnych do API (loginu i hasła), które pozwolą na uwierzytelnienie i wygenerowanie tokena autoryzacyjnego.

Dokumentacja metod udostępnianych w ramach API została opracowana za pomocą narzędzia Swagger UI.

Adres interfejsu API
https://sipam.gov.pl/service

Dokumentacja metod udostępniania w ramach API
https://sipam.gov.pl/service/swagger-ui/index.html

Przykładowy wynik wywołania interfejsu API
https://sipam.gov.pl/service/api/dictionaries/subject_types

Prezentacja
Dostęp do danych przy użyciu API