Po co łączyć system urzędu z wykazem?
Dokument środowiskowy zwykle powstaje albo trafia do urzędu w innym systemie: kancelaryjnym, dziedzinowym lub w aplikacji prowadzonej przez wydział. Tam są już jego nazwa, znak sprawy i data. Jeśli wykaz prowadzony jest osobno, pracownik przepisuje te same informacje drugi raz, a każde przepisywanie to okazja do pomyłki w numerze czy dacie.
Integracja przez API pozwala, żeby to system urzędu przekazywał dane do karty informacyjnej w Ekorejestr. Urzędnik nadal sprawdza kartę i decyduje o jej opublikowaniu, ale nie zaczyna od pustego formularza.
Jak działa API PDWD w Ekorejestr
Ekorejestr nie ma gotowych wtyczek do konkretnych programów. Działa to odwrotnie: to aplikacja urzędu łączy się z naszym API, niezależnie od tego, czy działa na komputerach urzędu, na jego serwerze, czy w zewnętrznym portalu.
- ✓ Dodawanie i aktualizacja kart - system urzędu może utworzyć kartę, uzupełnić ją później i odczytać jej numer oraz status.
- ✓ Szkic albo publikacja - karta bez daty zamieszczenia jest szkicem widocznym tylko w panelu urzędu. Do wykazu trafia dopiero po ustawieniu daty, przez system lub przez urzędnika.
- ✓ Bez duplikatów - system może przekazać własny identyfikator dokumentu. Ponowne wysłanie tego samego dokumentu nie utworzy drugiej karty.
- ✓ Te same zasady co w panelu - słowniki rodzajów (a-w) i tematów (a-h) z rozporządzenia, numeracja kart nadawana przez Ekorejestr, termin 14 dni liczony automatycznie.
Szczegóły techniczne, czyli adresy, pola karty, przykłady i kody błędów, opisuje dokumentacja API.
Droga 1: integracja samodzielna
Ta droga jest dla urzędów, których dostawca systemu albo informatyk może sam przygotować połączenie. Dokumentacja API jest publiczna, więc nie trzeba zamawiać u nas prac programistycznych.
- 1 Urząd korzystający z Ekorejestr zgłasza chęć integracji na kontakt@ekorejestr.pl i podaje nazwę systemu.
- 2 Wydajemy klucz API przypisany do tego urzędu i przekazujemy go bezpiecznym kanałem.
- 3 Dostawca systemu przygotowuje połączenie według dokumentacji API i sprawdza je na szkicach kart.
- 4 Urząd ustala z dostawcą, czy system ma publikować karty sam, czy tylko tworzyć szkice do zatwierdzenia przez urzędnika.
Droga 2: integracja wykonana przez nas (odpłatnie)
Jeśli urząd nie ma po swojej stronie nikogo, kto przygotuje połączenie, możemy wykonać integrację z systemem, z którego urząd korzysta. To usługa dodatkowa, poza abonamentem Ekorejestr, i zawsze poprzedza ją analiza.
- 1 Analiza - sprawdzamy, jak system urzędu udostępnia dane: czy ma własne API, eksport plików albo inny sposób przekazywania informacji o dokumentach.
- 2 Ustalenia - wspólnie określamy, które dokumenty mają trafiać do wykazu, które pola karty system może uzupełnić i kto zatwierdza publikację.
- 3 Wycena - koszt i termin podajemy po analizie, bo zależą od systemu urzędu i zakresu prac.
- 4 Wdrożenie i testy - uruchamiamy połączenie najpierw na szkicach kart, a do publikacji przechodzimy po akceptacji urzędu.
Nie każdy system da się podłączyć. Jeśli program urzędu nie pozwala odczytać danych o dokumentach w żaden sposób, powiemy o tym po analizie, zanim urząd poniesie koszt wdrożenia.
Bezpieczeństwo integracji
- ✓ Klucz działa tylko na kartach jednego urzędu. Karty innych urzędów są dla niego niewidoczne.
- ✓ Przez API nie da się usunąć ani wykreślić karty - te decyzje zostają w panelu, po stronie urzędnika.
- ✓ Każda zmiana jest zapisana w historii karty, tak samo jak zmiana wykonana w panelu.
- ✓ Urząd może sam unieważnić klucz w panelu, np. po wycieku albo zmianie dostawcy systemu, bez czekania na nas. Klucz może mieć też datę ważności i listę dozwolonych adresów IP.
Publiczne API PDWD: pobieranie danych z wykazu
Oprócz API dla systemów urzędu Ekorejestr ma publiczne API tylko do odczytu. Bez klucza i bez logowania można pobrać w formacie JSON karty opublikowane w wykazie, wyszukiwać je i filtrować po rodzaju dokumentu, temacie, roku i obszarze, a także pobrać słowniki rodzajów, tematów i obszarów TERYT.
Szkice i karty wykreślone nie są w nim widoczne. Ścieżki i parametry opisuje dokumentacja API PDWD.
A co z BIP?
Art. 23 ust. 1 ustawy OOŚ wymaga udostępnienia wykazu w Biuletynie Informacji Publicznej. Do tego nie jest potrzebna integracja: najprościej umieścić na podstronie BIP link do publicznego wykazu urzędu w Ekorejestr, który pokazuje wyłącznie karty tego urzędu. Przepis nie rozstrzyga, czy sam link wystarczy, dlatego warto opisać go pełną nazwą wykazu. Karty opublikowane w wykazie są też dostępne w publicznym API tylko do odczytu, bez klucza. Pełną odpowiedź znajdziesz w FAQ.
Najczęstsze pytania
Czy Ekorejestr to wykaz PDWD z API?
Tak. Ekorejestr ma API integracyjne, przez które systemy urzędu dodają i aktualizują karty, oraz publiczne API do pobierania danych z wykazu. Oba opisuje dokumentacja API.
Czy integracja jest konieczna, żeby korzystać z Ekorejestr?
Nie. Karty można dodawać ręcznie w panelu, także z pomocą asystenta AI. Integracja przydaje się, gdy dokumenty i tak są ewidencjonowane w innym systemie.
Czy macie gotową integrację z systemem, którego używamy?
Nie oferujemy gotowych integracji z konkretnymi programami. Każde połączenie przygotowuje dostawca systemu urzędu albo my, w ramach odpłatnej usługi po analizie.
Czy system urzędu może od razu publikować karty?
Technicznie tak, ale to urząd decyduje, jak ma być. Bezpieczniej zacząć od szkiców, które urzędnik sprawdza i publikuje w panelu.
Ile kosztuje integracja wykonana przez Was?
Podajemy wycenę po analizie systemu urzędu i ustaleniu zakresu. Integracja samodzielna, wykonana przez dostawcę systemu urzędu, nie wymaga zamawiania u nas prac programistycznych.
Co zrobić, gdy klucz API wycieknie?
Administrator urzędu unieważnia go od razu w panelu: Ustawienia, Moja organizacja, Klucze API. Nowy klucz wydajemy na prośbę urzędu wysłaną na kontakt@ekorejestr.pl.