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 – dodania zadania typu dokument. Opisana jest także zalecana kolejność wywoływania metod.
Moduł Do obsłużenia znajduje się w menu głównym systemu.
Aby dodać do niego nowe zadanie typu dokument, używamy metody.
POST /ezdrp/integrator/v2/obiegi
W odpowiedzi otrzymujemy identyfikator utworzonego zadania IdObiegu:
{
"listaIdObieg": [
"098865cef66f497d96ee8731409df607"
]
}
Zadanie pojawi się w systemie jako nowe, z przypisanym autorem — kontem powiązanym z użytym kluczem API. Przykładowy widok w systemie:
Po kliknięciu zadania (podjęciu go) wyświetla się nowy widok:
Jeśli do obiegu chcemy dodać dodatkowy dokument, używamy metody:
POST /ezdrp/integrator/v2/obiegi/{idObieg}/dokumenty
idObieg to identyfikator zadania, który uzyskaliśmy wcześniej, np.: 098865cef66f497d96ee8731409df607.
Można go również pobrać przy użyciu metody:
GET /ezdrp/integrator/v2/obiegi
Po wywołaniu POST/ezdrp/integrator/v2/obiegi/098865cef66f497d96ee8731409df607/dokumenty do zadania zostanie dołączony następny dokument.
Aby pracować dalej z dodanymi dokumentami, musimy uzupełnić ich metadane. Używamy metody:
PUT /ezdrp/integrator/v2/dokumenty/{idDokumentPrzestrzeni}/metadane
W celu uzyskania idDokumentPrzestrzeni najpierw pobieramy dokumenty w obiegu:
GET /ezdrp/integrator/v2/obiegi/{idObieg}/dokumenty
idObieg to wartość otrzymana zwrotnie po wywołaniu:
POST /ezdrp/integrator/v2/obiegi
W naszym przypadku zwrócona zostanie lista dwóch dokumentów. Interesuje nas wartość idDokumentPrzestrzeni.
{
"lista": [
{
"idDokumentPrzestrzeni": "49a653ceacea4cec98407f70683612bf",
"idDokument": "7c68728af8ca41a4a56e44d58f6196f8",
"idDokumentWersja": "347305d4ff734427bd979c2bc6405b6b",
"nazwa": "Dokument drugi.pdf",
"dataModyfikacji": "2025-03-23T16:03:53.812164",
"dataUtworzenia": "2025-03-23T16:03:53.526111",
"idPrzestrzenRobocza": "cb1b8d1019234bc784b6633eb7186480",
"liczbaZalacznikow": 0,
"czyPodpisany": false,
"czyZaakceptowany": false,
"czyMetadane": false,
"czyWSkladzieChronologicznym": false,
"etykieta": "",
"czyWystawionoZadanie": false,
"czyWystawionoZadanieUdostepnienia": false,
"czyWystawionoZadanieUdostepnieniaDoRealizacji": false,
"czyDokumentWplywu": false,
"czyTylkoDoOdczytu": false,
"czyZaakceptowanyWklad": false,
"rozszerzenie": ".pdf",
"czyTylkoDoOdczytuDlaNowoTworzonychZadan": false,
"czyWrazliwy": false,
"idStanowiskoAutor": "42ad53c712ff49aca1151ba21f3dd84a",
"idStanowiskoWlasciciel": "42ad53c712ff49aca1151ba21f3dd84a",
"typDokumentu": 0,
"typOdwzorowania": 0,
"isFileSignatureValid": true,
"idDokumentPrzestrzeniOryginal": "",
"dokumentWirtualny": false,
"czyKopia": false,
"czyIstniejeNowszaWersjaDokumentu": false,
"doPoprawy": false,
"zalaczniki": []
},
{
"idDokumentPrzestrzeni": "de3ff90314fe4d83956ae2ee1eb084fc",
"idDokument": "3ee88b0f076247ffb475c581cd79d229",
"idDokumentWersja": "376bbd50b32b4674901e18ae0c3d13c9",
"nazwa": "Dokument pierwszy.pdf",
"dataModyfikacji": "2025-03-23T15:48:02.848568",
"dataUtworzenia": "2025-03-23T15:48:02.848568",
"idPrzestrzenRobocza": "cb1b8d1019234bc784b6633eb7186480",
"liczbaZalacznikow": 0,
"czyPodpisany": false,
"czyZaakceptowany": false,
"czyMetadane": false,
"czyWSkladzieChronologicznym": false,
"etykieta": "",
"czyWystawionoZadanie": false,
"czyWystawionoZadanieUdostepnienia": false,
"czyWystawionoZadanieUdostepnieniaDoRealizacji": false,
"czyDokumentWplywu": false,
"czyTylkoDoOdczytu": false,
"czyZaakceptowanyWklad": false,
"rozszerzenie": ".pdf",
"czyTylkoDoOdczytuDlaNowoTworzonychZadan": false,
"czyWrazliwy": false,
"idStanowiskoAutor": "42ad53c712ff49aca1151ba21f3dd84a",
"idStanowiskoWlasciciel": "42ad53c712ff49aca1151ba21f3dd84a",
"typDokumentu": 0,
"typOdwzorowania": 0,
"isFileSignatureValid": true,
"idDokumentPrzestrzeniOryginal": "",
"dokumentWirtualny": false,
"czyKopia": false,
"czyIstniejeNowszaWersjaDokumentu": false,
"doPoprawy": false,
"zalaczniki": []
}
],
"pageInfo": {
"indexEnd": 1,
"indexStart": 0,
"pageNumber": 0,
"pageSize": 10,
"isNextPageExists": false
}
}
W odpowiedzi otrzymujemy listę dokumentów, np.:
idDokumentPrzestrzeni: 49a653ceacea4cec98407f70683612bf idDokumentPrzestrzeni: de3ff90314fe4d83956ae2ee1eb084fc
Dla każdego dokumentu z listy wykonujemy osobne wywołanie metody PUT, podając odpowiednie dane metadanych.
Aby je uzyskać, należy użyć metody:
GET /ezdrp/integrator/v2/metadane/konfiguracja
Z odpowiednim kluczem:
- 1 – Dokumenty
- 2 – Pisma (RPW)
- 3 – Adresaci (Kontakty) – Osoby fizyczne
- 4 – Adresaci (Kontakty) – Podmioty
- 5 – Sprawy
Poniżej przykład parametrów wywołania metody dla dokumentu o idDokumentPrzestrzeni: de3ff90314fe4d83956ae2ee1eb084fc. System wymaga, aby dla każdego dokumentu uzupełnione były trzy podstawowe metadane: Dostęp, Rodzaj i Typ dokumentu.
{
"metadane": [
{
"nazwa": "Dostęp",
"klucz": "2cd83224d3d1473db3bf67079d7e7083",
"wartosc": "EZDRP.Metadane.RPW.Dostep2"
},
{
"nazwa": "Rodzaj dokumentu",
"klucz": "fe1c0afe3a1c4c6f8057ec10757b2254",
"wartosc": "EZDRP.Metadane.Rodzaj.Dokumentu.5"
},
{
"nazwa": "Typ dokumentu",
"klucz": "cdc49e24eb6a41629b970c309f36f3cf",
"wartosc": "EZDRP.Metadane.RPW.Typ.1"
},
{
"nazwa": "Data na dokumencie",
"klucz": "d73eb676c84b4af4820e5f3eac1441b9",
"wartosc": "2025-03-22"
},
{
"nazwa": "Znak na dokumencie",
"klucz": "1f7426addb6e44498c9fe9f147ac8568",
"wartosc": "API/001"
}
]
}
Przykład odpowiedzi:
{
"metadane": [
{
"nazwa": "Dostęp",
"klucz": "2cd83224d3d1473db3bf67079d7e7083",
"wartosc": "EZDRP.Metadane.RPW.Dostep2",
"dataOperacji": "2025-03-23T16:38:37.0785842+01:00"
},
{
"nazwa": "Rodzaj dokumentu",
"klucz": "fe1c0afe3a1c4c6f8057ec10757b2254",
"wartosc": "EZDRP.Metadane.Rodzaj.Dokumentu.5",
"dataOperacji": "2025-03-23T16:38:37.0785842+01:00"
},
{
"nazwa": "Typ dokumentu",
"klucz": "cdc49e24eb6a41629b970c309f36f3cf",
"wartosc": "EZDRP.Metadane.RPW.Typ.1",
"dataOperacji": "2025-03-23T16:38:37.0785842+01:00"
},
{
"nazwa": "Data na dokumencie",
"klucz": "d73eb676c84b4af4820e5f3eac1441b9",
"wartosc": "2025-03-22",
"dataOperacji": "2025-03-23T16:38:37.0785842+01:00"
},
{
"nazwa": "Znak na dokumencie",
"klucz": "1f7426addb6e44498c9fe9f147ac8568",
"wartosc": "API/001",
"dataOperacji": "2025-03-23T16:38:37.0785842+01:00"
}
]
}
Przykład widoku w systemie:
Po poprawnym uzupełnieniu metadanych ikona statusu z literą M zostanie wyróżniona kolorem — możemy ją kliknąć, by podejrzeć szczegóły.
Aby dodać załącznik do dokumentu, używamy metody:
POST /ezdrp/integrator/v2/dokumenty/{idDokumentPrzestrzeni}/załączniki
Przykład:
POST /ezdrp/integrator/v2/dokumenty/de3ff90314fe4d83956ae2ee1eb084fc/załączniki
Po wywołaniu metody do dokumentu zostanie dodany załącznik:
Po dodaniu załącznika należy również uzupełnić jego metadane.
Na podstawie dokumentów (oraz ich załączników) możemy założyć nową sprawę:
POST /ezdrp/integrator/v2/obiegi/{idObieg}/sprawy
Przykładowe dane:
{
"idWykaz": "af5f009acaad458e99cc7fdb96668696",
"tytul": "Sprawa założona na obiegu",
"kategoriaArchiwalna": "A",
"typ": 0,
"numer": 0,
"rokZalozenia": 2025
}
idWykaz pobieramy poprzez wywołanie metod:
GET /ezdrp/integrator/v2/jrwa/schematy
GET /ezdrp/integrator/v2/jrwa/schematy/{idSchemat}/wykazy
Możemy również dodać dokumenty do już istniejącej sprawy:
/ezdrp/integrator/v2/obiegi/{idObieg}/sprawy/{idSprawa}
idSprawa pobieramy przez wyszukiwanie po znaku sprawy:
/POST /ezdrp/integrator/v2/sprawy/_search
{
"znakSprawy": "SSPASI.000.2.2025",
}