Mechanizm subskrypcji zdarzeń umożliwia użytkownikom otrzymywanie powiadomień o określonych zdarzeniach biznesowych w EZD RP. Dzięki temu możliwa jest automatyzacja procesów i bieżące reagowanie na zdarzenia bez konieczności manualnego monitorowania systemu.
Wymagane dane uwierzytelniające
Przed rozpoczęciem korzystania z subskrypcji użytkownik musi pobrać token dostępu z systemu SSO dla użytkownika, do którego przypisany jest ApiKey. Token jest wymagany do wywoływania endpointów integratora.
W nagłówkach żądania musi znaleźć się również SID, czyli identyfikator stanowiska przypisany do klucza API.
Dodanie subskrypcji w systemie EZD RP
Aby zasubskrybować zdarzenie, należy wykonać wywołanie HTTP POST na adres:
/ezdrp/integrator/v2/subskrypcje W żądaniu należy przesłać dane konfiguracyjne w formacie JSON, zawierające:
- lista zdarzeń,
- adres URL do odpowiedzi,
- adres e-mail na informacje o nieudanych próbach,
- kanał dostawy.
Należy też oczywiście dołączyć Access token otrzymany z SSO.
Zdarzenia dostępne do subskrypcji
Poniżej wymienione są zdarzenia, które można subskrybować w systemie.
Pismo (dodanie pisma do RPW)
- ezdrp.v2.pismo.dodanie.dodano
Dokument – akceptacja
- ezdrp.v2.dokument.akceptacja.zaakceptowano
- ezdrp.v2.dokument.akceptacja.anulowano
- ezdrp.v2.dokument.akceptacja.odrzucono
Dokument – podpis
- ezdrp.v2.dokument.podpis.zlozono
- ezdrp.v2.dokument.podpis.anulowano
- ezdrp.v2.dokument.podpis.odrzucono
Zadanie
- ezdrp.v2.zadanie.zakonczono
- ezdrp.v2.zadanie.anulowano
RPW
- ezdrp.v2.rpw.sprawa.utworzono
- ezdrp.v2.rpw.sprawa.dolaczono
Metadane
- ezdrp.v2.metadane.zmienionoKluczApi
Przykład konfiguracji subskrypcji
Wywołanie:
POST /ezdrp/integrator/v2/subskrypcje Przykładowe parametry:
{
"zdarzenia": [
{"ezdrp.v2.dokument.akceptacja.zaakceptowano"},
{"ezdrp.v2.dokument.podpis.zlozono"}
],
"konfiguracja": " {\"url\": \" http://mojUrlOdborcy.pl\"}",
"kanalDostawy": 0,
"email": "adres.odbiorcy@test.pl"
}
Gdzie kolejno:
- kluczZdarzenia – klucze zdarzeń z listy powyżej,
- konfiguracja – adres odbiorcy,
- kanalDostawy – obecnie dostępny: HTTP = 0,
- email – adres do powiadomień o problemach z wysyłką.
System EZD RP podejmuje cztery próby wysłania zdarzenia (każda z większym odstępem czasu). Po czwartej nieudanej próbie odbiorca zostaje dezaktywowany.
Przykład komunikatu:
Deaktywowano subskrypcję klucza o identyfikatorze 6b3890e8-b2fa-440f-a8c8-7e9dd6675f7f z powodu zbyt dużej liczby nieudanych prób połączenia.
Odblokowanie klucza jest możliwe poprzez wysłanie żądania PATCH na adres /ezdrp/integrator/v2/odbiorcy/aktywuj
Przed odblokowaniem klucza upewnij się, że problem został rozwiązany.
Przykładowa informacja o zdarzeniu wysyłana przez EZD RP
"Zdarzenia": [
{
"IdZdarzenie": "43d2496a-4f29-4fb9-8e54-11177a13f520",
"KluczZdarzenia": null,
"Dane": {
"Zdarzenia": [
{
"KluczZdarzenia": "ezdrp.v2.dokument.podpis.zlozono",
"IdDokument": "6be09be9bdbe41aab1934d15b135ce7c",
"IdPodpis": "41f15c2230ca4714aaba32b07fbf0224",
"DataZdarzenia": "2025-11-28T13:55:21.7543726+01:00"
}
]
}
}
]