API EZD RP pozwala systemom zewnętrznym uzyskiwać dostęp do zasobów EZD RP oraz korzystać z jego modułów i funkcji. W tej instrukcji przedstawione są metody API wykorzystywane do realizacji konkretnego celu biznesowego – zarejestrowania wysyłki korespondencji papierowej. Opisana jest także zalecana kolejność wywoływania metod.
Do zarejestrowania pojedynczej, wychodzącej przesyłki papierowej w systemie EZD RP używamy metody:
POST /ezdrp/integrator/v2/kw/wyslanie
Aby z niej skorzystać, musimy znać dwa identyfikatory:
- idPrzestrzenRobocza (w przykładzie: 646d718bc9884add97ed9cace340d057)
- idDokumentWersja (w przykładzie: b4f92b720f86428b886d3cb7cddd2cf4)
Można je uzyskać w następujący sposób:
- wyszukujemy sprawę
POST /ezdrp/integrator/v2/sprawy/_search
- pobieramy listę dokumentów w sprawie
GET /ezdrp/integrator/v2/sprawy/{idSprawa}/dokumenty
Do wysyłki potrzebne są również dane ze słowników:
- idRodzajPrzesylki
- idOperatorPrzesylki
- idStrefaPrzesylki
Wszystkie znajdują się w grupie słowników: EZDRP.Grupa.KorespondencjaWychodzaca.
Nazwy grup słowników możemy pobrać za pomocą metody:
GET /ezdrp/integrator/v2/slowniki/grupy
Konkretna grupa dla korespondencji wychodzącej:
GET /ezdrp/integrator/v2/slowniki/grupy/EZDRP.Grupa.KorespondencjaWychodzaca
Listę wpisów w słowniku pobieramy za pomocą metody:
GET /ezdrp/integrator/v2/slowniki/{kluczSlownika}
Poniżej widoczny jest przykład dla operatora (analogicznie pobieramy informacje o rodzaju przesyłki oraz strefie przesyłki):
GET /ezdrp/integrator/v2/slowniki/EZDRP.KW.Operator
Przykładowa odpowiedź:
{
"lista": [
{
"idSlownikWykaz": "EZDRP.KW.Operator1",
"nazwa": "Poczta Polska",
"klucz": "EZDRP.KW.Operator.PocztaPolska"
},
{
"idSlownikWykaz": "EZDRP.KW.Operator2",
"nazwa": "DHL",
"klucz": "EZDRP.KW.Operator.DHL"
},
{
"idSlownikWykaz": "EZDRP.KW.Operator3",
"nazwa": "DPD",
"klucz": "EZDRP.KW.Operator.DPD"
},
{
"idSlownikWykaz": "EZDRP.KW.Operator4",
"nazwa": "GLS",
"klucz": "EZDRP.KW.Operator.GLS"
},
{
"idSlownikWykaz": "EZDRP.KW.Operator5",
"nazwa": "FedEx",
"klucz": "EZDRP.KW.Operator.FedEx"
},
{
"idSlownikWykaz": "EZDRP.KW.Operator6",
"nazwa": "InPost",
"klucz": "EZDRP.KW.Operator.InPost"
},
{
"idSlownikWykaz": "EZDRP.KW.Operator7",
"nazwa": "UPS",
"klucz": "EZDRP.KW.Operator.UPS"
},
{
"idSlownikWykaz": "EZDRP.KW.Operator8",
"nazwa": "Pocztex",
"klucz": "EZDRP.KW.Operator.Pocztex"
},
{
"idSlownikWykaz": "EZDRP.KW.Operator9",
"nazwa": "GLOBAL EXPRESS",
"klucz": "EZDRP.KW.Operator.GlobalExpress"
}
]
}
W naszym przykładzie skorzystamy z wysyłki przez Pocztę Polską:
"idSlownikWykaz": "EZDRP.KW.Operator1",
"nazwa": "Poczta Polska",
"klucz": "EZDRP.KW.Operator.PocztaPolska"
Rodzaj przesyłki:
"idSlownikWykaz": "EZDRP.KW.RodzajPrzesylki1",
"nazwa": "list zwykły",
"klucz": "EZDRP.KW.RodzajPrzesylki.ListZwykly"
Strefa:
"idSlownikWykaz": "EZDRP.KW.Strefa1",
"nazwa": "krajowa",
"klucz": "EZDRP.KW.Strefa.Krajowa"
Aby uzyskać idAdresWersja, możemy:
- wyszukać adresata
POST /ezdrp/integrator/v2/adresaci/_search
- lub, jeśli mamy idAdresat, pobrać dane:
GET /ezdrp/integrator/v2/adresaci/{idAdresat}
W naszym przykładzie idAdresat to 408aab9ea6e640f5aadd39e2c0c8b8db, a idAdresWersja to dfa7db7772eb4a2cb552417d621abefb.
Gdy mamy już wszystkie dane, możemy wywołać metodę:
POST /ezdrp/integrator/v2/kw/wyslanie
Przykładowe dane:
{
"idPrzestrzenRobocza": "646d718bc9884add97ed9cace340d057",
"idRodzajPrzesylki": "EZDRP.KW.RodzajPrzesylki1",
"idOperatorPrzesylki": "EZDRP.KW.Operator1",
"dodatkoweInformacje": "dodatkowe informacje",
"idStrefaPrzesylki": "EZDRP.KW.Strefa1",
"listaAdresatow": [
{
"idAdresWersja": "dfa7db7772eb4a2cb552417d621abefb"
}
],
"listaIdDokumentWersja": [
"b4f92b720f86428b886d3cb7cddd2cf4"
],
"czyPriorytet": true,
"idSprawy": "ba7308c651324f83ac179184ba5dec5a",
"znakSprawy": "SSPASI.000.3.2025",
"czyNumerNadawczyOdklejany": true,
"zawartoscKoperty": "wezwanie"
}
Przykładowa odpowiedź:
{
"listaIdKorespondencjiWychodzacejPapierowej": [],
"listaKorespondencji": [
{
"idKorespondencja": "a5e7a03e00d04cb3a0cf69457f115ca3",
"numerRKW": "RKW/2/2025"
}
]
}
Widok w systemie w sekcji Wysyłki w sprawie:
Informacje o wysyłkach w sprawie można pobrać metodą:
GET /ezdrp/integrator/v2/sprawy/{idSprawa}/kw
W naszym przykładzie to:
GET /ezdrp/integrator/v2/sprawy/ba7308c651324f83ac179184ba5dec5a/kw
Status przesyłki:
- Zarejestrowana – po wykonaniu powyższej operacji.
- Wysłana – gdy kancelaria fizycznie nada przesyłkę.
- Anulowana – gdy wysyłka zostanie wycofana.
System zaktualizuje statusy również w sekcji Wysyłki w sprawie.