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 dokumentu do rejestru przesyłek wpływających (RPW). Opisana jest także zalecana kolejność wywoływania metod.
Aby dodać dokument do RPW w systemie EZD RP, należy skorzystać z metody:
POST /ezdrp/integrator/v2/dokumenty/{idDokumentPrzestrzeni}/rpw
Metody tej używamy w sytuacji, gdy dokument został już utworzony w systemie EZD RP i znamy już jego idDokumentPrzestrzeni. W przeciwnym wypadku możemy skorzystać np. z metody:
POST /ezdrp/integrator/v2/dokumenty/_search
Przykładowe zapytanie:
{
"idDokument": "",
"tytul": "Dokument drugi",
"dataUtworzeniaOd": "2025-03-01",
"dataUtworzeniaDo": "2025-03-31",
"atrybuty": [
],
"pageInfo": {
"pageNumber": 0,
"pageSize": 20
}
}
Przykładowa odpowiedź:
{
"lista": [
{
"idDokument": "7c68728af8ca41a4a56e44d58f6196f8",
"nazwa": "Dokument drugi",
"dataUtworzenia": "2025-03-23T16:03:53.526111",
"listaDokumentPrzestrzeni": [
{
"idDokumentPrzestrzeni": "49a653ceacea4cec98407f70683612bf",
"idPrzestrzenRobocza": "3d432cd6d28b4c1293356123f7f04ad3"
}
],
"idStanowiskoWlasciciel": "42ad53c712ff49aca1151ba21f3dd84a",
"wlasciciel": {
"imie": "Patrycja",
"nazwisko": "Świętokrzyska",
"komorkaOrganizacyjna": "Samodzielne Stanowisko Pracy ds. Administracji Systemami Informatycznymi",
"stanowisko": "Administrator",
"symbolKomorki": "SSPASI"
},
"sprawy": [
{
"idSprawa": "89fe810133384358af7210a054cb08bd",
"znakSprawy": "SSPASI.002.1.2025",
"tytul": "Sprawa z API",
"kategoriaArchiwalna": "A",
"idStanowiskoProwadzacy": "42ad53c712ff49aca1151ba21f3dd84a",
"listaIdPrzestrzenRobocza": [
"8eedd5901bd747b69079acf31d431f0d",
"3d432cd6d28b4c1293356123f7f04ad3"
]
}
]
}
],
"pageInfo": {
"indexEnd": 0,
"indexStart": 0,
"pageNumber": 0,
"pageSize": 20,
"isNextPageExists": false
}
}
Z powyższej odpowiedzi pobieramy idDokumentPrzestrzeni, np. idDokumentPrzestrzeni=49a653ceacea4cec98407f70683612bf. Następnie wywołujemy metodę:
POST /ezdrp/integrator/v2/dokumenty/49a653ceacea4cec98407f70683612bf/rpw
Przykładowa odpowiedź:
{
"idPismo": "0d6ab1e4f0f2420a814deb7d10f69678",
"numerRpw": "RPW/1/2025"
}
Dokument zostaje dodany do RPW, a system nadał mu numer: RPW/1/2025. W systemie pojawi się odpowiedni wpis.
Jeśli do wpływu chcemy dodać załącznik, korzystamy z metody:
POST /ezdrp/integrator/v2/rpw/{numer}/{rok}/zalaczniki
Przykład:
POST /ezdrp/integrator/v2/rpw/1/2025/zalaczniki
Załącznik będzie widoczny w systemie:
Po dodaniu plików do systemu EZD RP, konieczne jest uzupełnienie ich metadanych. Do aktualizacji metadanych korzystamy z metody:
PUT /ezdrp/integrator/v2/rpw/{numer}/{rok}/metadane
Dostępne identyfikatory i wartości wymagane w tym kroku można wcześniej pobrać metodą:
GET /ezdrp/integrator/v2/rpw/{numer}/{rok}/metadane
Przykład uzupełnienia metadanych dla nadawcy anonimowego:
{
"metadaneSystemowe": {
"dataWplywu": "2025-04-02",
"dataNadania": "2025-04-02",
"dataNaPismie": "2025-03-31",
"uwagi": "Brak uwag",
"znakNaPismie": "AAA-TEST",
"numerNadawczy": "7567867868",
"sposobDostarczenia": "EZDRP.Metadane.SposobDostarczenia6",
"rodzajDokumentu": "EZDRP.Metadane.Rodzaj.Dokumentu.22",
"typDokumentu": "EZDRP.Metadane.RPW.Typ.8",
"dostep": "EZDRP.Metadane.RPW.Dostep3",
"czyAnonimowy": true
}
}
Przykład uzupełnienia metadanych z określonym nadawcą:
{
"metadaneSystemowe": {
"dataWplywu": "2025-04-02",
"dataNadania": "2025-04-02",
"dataNaPismie": "2025-03-31",
"uwagi": "Brak uwag",
"znakNaPismie": "AAA-TEST",
"numerNadawczy": "7567867868",
"sposobDostarczenia": "EZDRP.Metadane.SposobDostarczenia6",
"rodzajDokumentu": "EZDRP.Metadane.Rodzaj.Dokumentu.22",
"typDokumentu": "EZDRP.Metadane.RPW.Typ.8",
"dostep": "EZDRP.Metadane.RPW.Dostep3",
"czyAnonimowy": false
},
"adresaci": [
{
"idAdresWersja": "408aab9ea6e640f5aadd39e2c0c8b8db",
"rodzaj": "EZDRP.RPW.RodzajNadawcy.1"
}
]
}
Lista możliwych wartości (np. EZDRP.RPW.RodzajNadawcy.1) pochodzi ze słownika, który można pobrać metodą:
GET /ezdrp/integrator/v2/slowniki/grupy/{idGrupa}
Dla nadawców należy użyć:
idGrupa=EZDRP.Grupa.Sprawy
W zwróconym słowniku należy znaleźć pozycję o kluczu: EZDRP.RPW.RodzajNadawcy.
Po poprawnym uzupełnieniu metadanych ikona statusu z literą M zostaje oznaczona na różowo.
