Interfejsy API
W ramach projektu e-Doręczeń przygotowano interfejsy zewnętrzne (API), które umożliwiają integrację autoryzowanych systemów elektronicznego zarządzania dokumentacją (EZD) i innych systemów dziedzinowych (na przykład kancelaryjnych) z ekosystemem e-Doręczeń.
User Agent API (UA API) umożliwia komunikację związaną z przygotowaniem, wysyłaniem i odbieraniem wiadomości oraz ich magazynowaniem i udostępnianiem przez system dostawcy usług e-Doręczeń (wyszukiwanie, pobieranie do odczytu, aktualizacja, usuwanie). Zapewnia jednocześnie doręczenie wiadomości do odbiorcy z gwarancją jej niezaprzeczalności i integralności.
Search Engine API (SE API) to interfejs wyszukiwania adresu do e-Doręczeń odbiorcy na podstawie danych w bazie adresów elektronicznych.
Poniżej przedstawiamy informacje o obowiązujących wersjach UA API i SE API do integracji ze środowiskiem testowym (INT) i produkcyjnym (PROD), a także o planowanych zmianach w tych interfejsach.
Środowisko testowe INT
User Agent API (UA API)
Wersje obowiązujące
- UA API 2 – 1.0.16.yaml
- UA API 1 – 1.0.7.yaml
Zmiany między UA API 1 i UA API 2 są kompatybilne wstecz – lista zmian w sekcji Materiały.
Planowane zmiany
Planowane jest wystawienie przez Operatora Wyznaczonego nowego, trzeciego endpointu UA API – UA API 3 – 1.0.25 yaml – data wdrożenia zostanie podana po testach.
Zmiany między wersjami UA API 1.0.16 i 1.0.25 są kompatybilne wstecz – lista zmian w sekcji Materiały.
Search Engine API (SE API)
Wersje obowiązujące
- SE API 2 – 2.0.3.yaml
- SE API 1 – 1.0.14.yaml
Zmiany między wersjami SE API 1 i SE API 2 – lista zmian w sekcji Materiały.
Środowisko produkcyjne PROD
User Agent API (UA API)
Wersje obowiązujące
- UA API 2 – 1.0.16.yaml
- UA API 1 – 1.0.7.yaml
Search Engine API (SE API)
Wersje obowiązujące
- SE API 2 – 2.0.3.yaml
- SE API 1 – 1.0.14.yaml
Materiały
Lista zmian UA API między wersją 1.0.16 1.0.25Lista_zmian_UA_API_między_wersją_1016_1025.pdf 0.29MB Lista zmian UA API między wersją 1.0.7 i 1.0.16
Lista_zmian_UA_API_między_wersją_107_i__1016_final.pdf 0.28MB Lista zmian SE API między wersją 1.0.14 i 2.0.3
Lista_zmian_SE_API_między_wersją_1014_i_203_final.pdf 0.30MB 1.0.25.yaml (plik yaml)
uaapi_1025.yaml 0.07MB
Data aktualizacji: 10.04.2024 r.