Podręcznik użytkownika systemu EZD RP

Przykłady użycia metod API EZD RP

Ostatnia aktualizacja 17 października 2025 o godz. 09:51
Za pomocą metod API EZD RP możliwy jest dostęp systemów zewnętrznych do zasobów systemu EZD RP oraz wywoływanie i wykorzystywanie jego modułów i funkcji. Poniższa lista zawiera opisy wraz z kolejnością wywołania metod API EZD RP używanych do realizacji wybranych celów biznesowych.
  1. Wykonywanie operacji w kontekście wybranego użytkownika – w żądaniu generowania tokenu należy przekazać UID – opcjonalny identyfikator użytkownika w systemie EZD RP, na którego koncie zostanie wykonana operacja. Wybór stanowiska użytkownika, w kontekście którego wywoływana jest metoda, realizowany jest poprzez dodanie pola Sid zawierającego identyfikator stanowiska w nagłówku metody. Stanowiska użytkownika, dla którego mamy wystawiony token sesyjny, możemy pobrać przy użyciu metody /ezdrp/integrator/v1/uzytkownik/pobierz.
    • Pobranie jednostek /ezdrp/integrator/v1/jednostki/pobierz
    • Pobranie komórki organizacyjnej /ezdrp/integrator/v1/komorka-organizacyjna/pobierz
    • Pobranie stanowisk w wybranej jednostce /ezdrp/integrator/v1/stanowiska/pobierz
    • Wyszukanie użytkownika /ezdrp/integrator/v1/uzytkownik/wyszukaj

    2. Sid stanowiska, które jest przypisane do klucza API widoczne jest w Administracja > Klucze API.

  2. Dodanie pliku do repozytorium plików
    • Pobranie tokena dodawania dokumentów /ezdrp/integrator/v1/upload-token/pobierz
    • Wywołanie metody https://filerepo-api.int2.ezdrp.gov.pl/api/Upload/file-upload
      • Dodanie do nagłówka żądania Key: ftoken oraz Value: wartości tokena otrzymanego w odpowiedzi z pobrania tokena dodawania pliku,
      • Wybranie w zakładce Body typu form-data, utworzenie w Key klucza o nazwie files oraz wybranie typu File z rozwijanej listy, a następnie w Value wybranie Select files i wskazanie wysyłanego pliku.
  3. Dodanie dokumentu (bez sprawy) – dodanie pisma bez RPW
    • Dodanie pliku do repozytorium
    • Dodanie dokumentu /ezdrp/integrator/v1/dokument/dodaj
    • Dodanie pisma /ezdrp/integrator/v1/pismo/dodaj
    • Uzupełnienie metadanych dokumentu
      • Pobranie grup słowników /ezdrp/integrator/v1/slowniki/grupy/pobierz
      • Pobranie listy słowników w grupie /ezdrp/integrator/v1/slowniki/lista/pobierz dla „idGrupa”: „EZDRP.Grupa.Metadane.Listy.Wartosci”
      • Pobranie listy metadanych dla kluczy słowników o nazwach: Typ dokumentu, RPW Dostęp, RPW Rodzaj dokumentu /ezdrp/integrator/v1/pobierz-wykazy-slownika, podając dla wymienionych słowników klucze
      • Pobranie konfiguracji dodatkowych metadanych (atrybutów) dokumentu /ezdrp/integrator/v1/dokument/metadane/konfiguracja
      • Aktualizacja metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/aktualizuj
  4. Dodanie kolejnego dokumentu do pisma
    • Dodanie pisma bez RPW lub rejestracja przesyłki wpływającej
    • Dodanie dokumentu do pisma /ezdrp/integrator/v1/pismo/dodaj-zalacznik
  5. Dodanie dokumentu do sprawy
    • Dodanie pliku do repozytorium plików
    • Dodanie dokumentu do sprawy /ezdrp/integrator/v1/sprawa/dokument/dodaj
    • Uzupełnienie metadanych dokumentu
      • Pobranie grup słowników /ezdrp/integrator/v1/slowniki/grupy/pobierz
      • Pobranie listy słowników w grupie /ezdrp/integrator/v1/slowniki/lista/pobierz dla „idGrupa”: „EZDRP.Grupa.Metadane.Listy.Wartosci”
      • Pobranie listy metadanych dla kluczy słowników o nazwach: Typ dokumentu, RPW Dostęp, RPW Rodzaj dokumentu
        /ezdrp/integrator/v1/pobierz-wykazy-slownika, podając dla wymienionych słowników klucze
      • Pobranie konfiguracji dodatkowych metadanych (atrybutów) dokumentu /ezdrp/integrator/v1/dokument/metadane/konfiguracja
      • Aktualizacja metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/aktualizuj
  6. Aktualizacja zawartości dokumentu w sprawie
    • Dodanie pliku do repozytorium plików
    • Aktualizacja zawartości dokumentu /ezdrp/integrator/v1/dokument/dodaj-nowa-wersje
  7. Pobranie szczegółów dokumentu /ezdrp/integrator/v1/dokument/pobierz
  8. Wysłanie zeskanowanego dokumentu
    • Dodanie zeskanowanego pliku do repozytorium plików EZD RP
      • Pobranie tokena dodawania dokumentów /ezdrp/integrator/v1/upload-token/pobierz
      • Wywołanie metody https://filerepo-api.int2.ezdrp.gov.pl/api/Upload/file-upload
        • Dodanie do nagłówka żądania Key: ftoken oraz Value: czyli wartości tokena otrzymanego w odpowiedzi z pobrania tokena dodawania pliku
        • Wybranie w zakładce Body form-data oraz z rozwijanej listy File oraz poprzez wskazanie wysyłanego pliku za pomocą Select files
    • Aktualizacja dokumentu /ezdrp/integrator/v1/dokument-skan/aktualizuj
  9. Rejestracja przesyłki wpływającej
    • Dodanie pliku do repozytorium plików
    • Dodanie dokumentu /ezdrp/integrator/v1/dokument/dodaj
    • Dodanie pisma /ezdrp/integrator/v1/pismo/dodaj z parametrem „rpw”: true
    • Uzupełnienie metadanych przesyłki wpływającej:
      • Pobranie grup słowników /ezdrp/integrator/v1/slowniki/grupy/pobierz
      • Pobranie listy słowników w grupie /ezdrp/integrator/v1/slowniki/lista/pobierz dla „idGrupa”: „EZDRP.Grupa.Metadane.Listy.Wartosci”
        RPW sposób dostarczenia
      • Pobranie listy metadanych dla słownika /ezdrp/integrator/v1/pobierz-wykazy-slownika np. „klucz”: „EZDRP.Metadane.Listy.Wartosci1”
      • Wyszukanie nadawcy /ezdrp/integrator/v1/adresat/wyszukaj pobranie idAdresWersjaDoWyswietlenia
      • Pobranie nadawcy /ezdrp/integrator/v1/adresat/pobierz
      • Pobranie konfiguracji metadanych obiektu pisma /ezdrp/integrator/v1/pismo/metadane/konfiguracja
      • Uzupełnienie metadanych pisma /ezdrp/integrator/v1/pismo-rpw/uzupelnij
    • Dodanie kolejnego dokumentu do pisma /ezdrp/integrator/v1/pismo/dodaj-zalacznik
  10. Dekretacja pisma z RPW lub bez RPW
    • Dodanie pisma bez RPW lub rejestracja przesyłki wpływającej
    • Uzupełnienie metadanych dokumentu lub przesyłki wpływającej
    • Pobranie jednostek /ezdrp/integrator/v1/jednostki/pobierz
    • Pobranie stanowisk w wybranej jednostce /ezdrp/integrator/v1/stanowiska/pobierz
    • Dekretacja pisma /ezdrp/integrator/v1/zadanie/do-dekretacji/dodaj
  11. Pobranie danych wpływu po numerze RPW /ezdrp/integrator/v1/pismo/pobierz
  12. Pobranie danych pisma po ID przestrzeni /ezdrp/integrator/v1/pismo/przestrzen/pobierz
  13. Dołączenie pisma z RPW lub bez RPW do istniejącej w systemie sprawy
    • Dodanie dokumentu (bez sprawy) lub rejestracja przesyłki wpływającej
    • Uzupełnienie metadanych dokumentu lub przesyłki wpływającej
    • Dołączenie pisma do sprawy /ezdrp/integrator/v1/pismo/dodaj-do-sprawy
  14. Zakończenie pisma z RPW lub bez RPW
    • Dodanie pisma bez RPW lub rejestracja przesyłki wpływającej
    • Pobranie ze słownika powodu zakończenia pisma
      • Pobranie grup słowników /ezdrp/integrator/v1/slowniki/grupy/pobierz
      • Pobranie listy słowników oraz wykazów w grupie /ezdrp/integrator/v1/slowniki/lista/pobierz dla „idGrupa”: „EZDRP.Grupa.KorespondencjaWplywajaca”
    • Zakończenia pisma /ezdrp/integrator/v1/pismo/zakoncz
  15. Wznowienie pisma z RPW lub bez RPW
    • Zakończenie pisma z RPW lub bez RPW
    • Wznowienie pisma /ezdrp/integrator/v1/pismo/wznow
  16. Dodawanie podteczki do wykazu JRWA
    • Dodawanie podteczki do wykazu /ezdrp/integrator/v1/jrwa/dodaj-podteczke
  17. Pobranie wykazu
    • Jeśli jest jeden schemat JRWA – pobranie wykazu dla domyślnego schematu JRWA /ezdrp/integrator/v1/jrwa/wykazy/pobierz – w body ustawić none
    • Jeżeli jest więcej niż jeden schemat JRWA – pobranie dostępnych schematów JRWA /ezdrp/integrator/v1/jrwa/schematy/pobierz
      • Pobranie wykazu dla wybranego schematu JRWA /ezdrp/integrator/v1/jrwa/wykazy/pobierz , podając odpowiedni idSchematJrwa
  18. Utworzenie sprawy na podstawie pisma bez RPW lub z RPW
    • Rejestracja przesyłki wpływającej lub dodanie dokumentu bez sprawy
    • Uzupełnienie metadanych dokumentu lub przesyłki wpływającej
    • Pobranie wykazu
    • Utworzenie sprawy /ezdrp/integrator/v1/sprawa/utworz
  19. Utworzenie sprawy
    • Pobranie wykazu
    • Utworzenie nowej sprawy /ezdrp/integrator/v1/sprawa/utworz-pusta – w przypadku wywołania metody w wersji 12 podawany był symbol JRWA. W aktualnej wersji API należy podać identyfikator tego symbolu w schemacie JRWA. Identyfikator można uzyskać po wykonaniu następujących kroków:
      • /ezdrp/integrator/v1/jrwa/schematy/pobierz – pobiera wszystkie schematy dostępne w systemie;
      • /ezdrp/integrator/v1/jrwa/wykazy/pobierz – pobiera cały wykaz z wybranego schematu.
  20. Pobranie danych sprawy
    • Pobranie pełnych danych sprawy /ezdrp/integrator/v1/sprawa/pobierz
    • Pobranie statusu sprawy /ezdrp/integrator/v1/sprawa/status/pobierz
    • Pobranie statusu i prowadzącego sprawę /ezdrp/integrator/v1/sprawa/szczegoly/pobierz
    • Pobranie listy dokumentów w sprawie/ezdrp/integrator/v1/sprawa/obiekty/pobierz
  21. Tworzenie zadania akceptacji dla:
    • Dokumentu w sprawie
      • Dodanie dokumentu do sprawy
      • Pobranie szczegółów sprawy /ezdrp/integrator/v1/sprawa/pobierz
      • Dodanie zadania akceptacji dla dodanego dokumentu w sprawie /ezdrp/integrator/v1/zadanie/do-akceptacji/dodaj
    • Dokumentu bez sprawy
      • Dodanie dokumentu bez sprawy
      • Dodanie zadania akceptacji dla dodanego dokumentu /ezdrp/integrator/v1/zadanie/do-akceptacji/dodaj
  22. Usunięcie znaku sprawy
    • Pobranie danych sprawy /ezdrp/integrator/v1/sprawa/pobierz
    • Usunięcie znaku sprawy /ezdrp/integrator/v1/sprawa/usun-znak
  23. Przerejestrowanie sprawy
    • Pobranie danych sprawy /ezdrp/integrator/v1/sprawa/pobierz
    • Pobranie wykazu
    • Przerejestrowanie sprawy /ezdrp/integrator/v1/sprawa/przerejestruj
  24. Zawieszenie sprawy
    • Pobranie danych sprawy /ezdrp/integrator/v1/sprawa/pobierz
    • Zawieszenie sprawy /ezdrp/integrator/v1/sprawa/zawies
  25. Wznowienie sprawy
    • Pobranie danych sprawy /ezdrp/integrator/v1/sprawa/pobierz
    • Wznowienie sprawy /ezdrp/integrator/v1/sprawa/wznow
  26. Odłożenie sprawy
    • Pobranie danych sprawy /ezdrp/integrator/v1/sprawa/pobierz
    • Odłożenie sprawy /ezdrp/integrator/v1/sprawa/odloz
  27. Zakończenie sprawy
    • Pobranie danych sprawy /ezdrp/integrator/v1/sprawa/pobierz
    • Pobranie grup słowników /ezdrp/integrator/v1/slowniki/grupy/pobierz
    • Pobranie słownika dot. spraw /ezdrp/integrator/v1/slowniki/lista/pobierz dla EZDRP.Grupa.Sprawy oraz wybór wartości dla EZDRP.Sprawy.PowodZakonczenia
    • Zakończenie sprawy /ezdrp/integrator/v1/sprawa/zakoncz
  28. Aktualizacja danych sprawy
    • Pobranie danych sprawy /ezdrp/integrator/v1/sprawa/pobierz
    • Aktualizacja
      • Danych podstawowych /ezdrp/integrator/v1/sprawa/zmien
      • Atrybutów
        • Pobranie konfiguracji metadanych sprawy /ezdrp/integrator/v1/sprawa/metadane/konfiguracja
        • Aktualizacja atrybutów sprawy /ezdrp/integrator/v1/sprawa/aktualizuj
  29. Zmiana prowadzącego sprawę
    • Pobranie stanowiska użytkownika
      • Pobranie jednostek /ezdrp/integrator/v1/jednostki/pobierz
      • Pobranie komórki organizacyjnej /ezdrp/integrator/v1/komorka-organizacyjna/pobierz
      • Pobranie stanowisk w wybranej jednostce /ezdrp/integrator/v1/stanowiska/pobierz
    • Zmiana prowadzącego /ezdrp/integrator/v1/sprawa/zmien-prowadzacego
  30. Pobranie listy spraw
    • Pobranie wykazu
    • Pobranie jednostek /ezdrp/integrator/v1/jednostki/pobierz
    • Pobranie listy spraw /ezdrp/integrator/v1/sprawy/pobierz
  31. Dodanie ePisma w sprawie
    • Opcjonalnie dodanie dokumentu do sprawy
    • Wyszukanie adresata
    • Pobranie rodzaju ePisma /ezdrp/integrator/v1/pismo/rodzaje/pobierz
    • Dodanie ePisma /ezdrp/integrator/v1/pismo/dodaj-nowe-epismo
  32. Rejestracja korespondencji wychodzącej papierowej
    • Dodanie dokumentu do sprawy
    • Pobranie konfiguracji metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/konfiguracja
    • Pobranie grup słowników /ezdrp/integrator/v1/slowniki/grupy/pobierz
    • Pobranie listy słowników w grupie /ezdrp/integrator/v1/slowniki/lista/pobierz dla „idGrupa”: „EZDRP.Grupa.KorespondencjaWychodzaca”
    • Pobranie identyfikatorów z wykazów słownika /ezdrp/integrator/v1/pobierz-wykazy-slownika dla poniższych kluczy:
      • EZDRP.KW.RodzajPrzesylki dla rodzaju przesyłki
      • EZDRP.KW.Strefa dla strefy
      • EZDRP.KW.Operator dla operatora
    • Uzupełnienie metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/aktualizuj
    • Wyszukanie adresata /ezdrp/integrator/v1/adresat/wyszukaj pobranie idAdresWersjaDoWyswietlenia
    • Rejestracja korespondencji wychodzącej papierowej /ezdrp/integrator/v1/korespondencja-wychodzaca-as-zarejestruj-korespondencje
  33. Rejestracja korespondencji wychodzącej zbiorczej
    • Dodanie dokumentu do sprawy
    • Pobranie konfiguracji metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/konfiguracja
    • Uzupełnienie metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/aktualizuj
    • Wyszukanie adresata /ezdrp/integrator/v1/adresat/wyszukaj pobranie idAdresWersjaDoWyswietlenia
    • Rejestracja korespondencji wychodzącej zbiorczej /ezdrp/integrator/v1/korespondencja-wychodzaca-zbiorcza-as-zarejestruj-korespondencje
  34. Rejestracja korespondencji wychodzącej e-mail
    • Dodanie dokumentu do sprawy
    • Pobranie konfiguracji metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/konfiguracja
    • Uzupełnienie metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/aktualizuj
    • Wyszukanie adresata /ezdrp/integrator/v1/adresat/wyszukaj pobranie idAdresWersjaDoWyswietlenia
    • Rejestracja korespondencji wychodzącej e-mail /ezdrp/integrator/v1/korespondencja-wychodzaca/wyslij-email
  35. Rejestracja korespondencji faksowej
    • Dodanie dokumentu do sprawy /ezdrp/integrator/v1/sprawa/dokument/dodaj
    • Pobranie konfiguracji metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/konfiguracja
    • Uzupełnienie metadanych dokumentu /ezdrp/integrator/v1/dokument/metadane/aktualizuj
    • Wyszukanie adresata /ezdrp/integrator/v1/adresat/wyszukaj pobranie idAdresWersjaDoWyswietlenia
    • Rejestracja korespondencji wychodzącej faksem /ezdrp/integrator/v1/korespondencja-wychodzaca-as-zarejestruj-korespondencje-fax
  36. Pobranie statusu korespondencji wychodzącej
    • Rejestracja korespondencji wychodzącej papierowej
    • Pobranie statusu korespondencji /ezdrp/integrator/v1/korespondencja-wychodzaca/status/pobierz
  37. Pobranie informacji o korespondencji wychodzącej z rejestru korespondencji wychodzącej
    • Rejestracja korespondencji
    • Pobranie danych z rejestru korespondencji wychodzącej /ezdrp/integrator/v1/rejestr/korespondencja-wychodzaca/pobierz
  38. Kopia pisma z załącznikami
    • Dodanie dokumentu (bez sprawy) – dodanie pisma bez RPW lub Rejestracja przesyłki wpływającej
    • Utworzenie kopii pisma wraz z wybranymi załącznikami /ezdrp/integrator/v1/pismo/kopiuj

Zobacz także

Dostęp do środowiska API EZD RP
Instrukcja instalacji EZD RP – środowisko produkcyjne
Uwierzytelnianie systemów zewnętrznych
Wykorzystanie klucza API w komunikacji z EZD RP