W celu świadczenia usług na najwyższym poziomie stosujemy pliki cookies. Korzystanie z naszej witryny oznacza, że będą one zamieszczane w Państwa urządzeniu. W każdym momencie można dokonać zmiany ustawień Państwa przeglądarki. Zobacz politykę cookies.

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 3  – 3.0.8.yaml
  • UA API 2 – 1.0.16.yaml
  • UA API 1 – 1.0.7.yaml

Zmiany między UA API 1, UA API 2 i UA API 3 są kompatybilne wstecz – lista zmian w sekcji Materiały.

 

Search Engine API (SE API)

Wersje obowiązujące

  • SE API 3 – 3.0.4.yaml 
  • SE API 2 – 2.0.3.yaml
  • SE API 1 – 1.0.14.yaml

Zmiany  między wersjami SE API 1 do SE API 3 – lista zmian w sekcji Materiały.

Środowisko produkcyjne PROD

User Agent API (UA API)
 

Wersje obowiązujące

  • UA API 3  – 3.0.8.yaml
  • 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 3 – 3.0.2.yaml 
  • SE API 2 – 2.0.3.yaml
  • SE API 1 – 1.0.14.yaml

Planowana wersja SE API 3 – 3.0.4.yaml do wejścia na PROD 18.12.2024 r.

Materiały

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 3.0.4
Lista​_zmian​_SE​_API​_między​_wersją​_1014​_i​_304.pdf 0.21MB
Lista zmian w UA API V2 do V3
Zmiany​_w​_UA​_API​_V2​_vs​_V308.pdf 0.20MB
Projekt Techniczny UA API
UAAPI V3 - 3.0.8 YAML

Data aktualizacji: 11.12.2024 r.

{"register":{"columns":[]}}