Pełna referencja API EZD RP jest publicznie utrzymywana w formacie Swagger / OpenAPI 3.0 — z poziomu gov.pl. Dla wersji v2 dokumentacja zawiera: pełną listę endpointów, modele danych, przykładowe request/response, kody błędów. To pierwsze źródło prawdy dla każdego integratora.
Jak czytać Swagger UI
- Lewa kolumna — lista endpointów pogrupowana tematycznie (Sprawy, Dokumenty, JRWA, RPW)
- Środek — szczegóły wybranego endpointu: metoda HTTP, ścieżka, parametry, odpowiedzi
- 'Try it out' — przycisk pozwalający wysłać request bezpośrednio z UI (po podaniu klucza API)
- Schemas — definicje obiektów (modeli) używanych w request/response
Najważniejsze sekcje dokumentacji
| Sekcja | Co znajdziesz | Po co |
|---|---|---|
| Authentication | Sposób uwierzytelnienia (API Key, kontekst użytkownika) | Pierwszy krok integracji |
| Sprawy | Endpointy do tworzenia, czytania, modyfikacji spraw | Główny obiekt biznesowy EZD RP |
| Dokumenty / Pisma | Operacje na dokumentach w sprawach | Załączniki, treść dokumentów |
| RPW | Rejestr Przesyłek Wpływających | Dodawanie korespondencji do systemu |
| JRWA | Jednolity Rzeczowy Wykaz Akt | Klasyfikacja spraw |
| Files / Upload | Upload-token, upload pliku, pobieranie | Praca z załącznikami |
| Webhooks (jeśli dostępne) | Subskrypcja zdarzeń | Push z EZD RP do Twojego systemu |
Sprawdzanie wersji
Swagger UI pokazuje numer wersji API w nagłówku. Dla EZD RP używaj wersji v2 lub nowszej — starsze (v1) są deprecated. Wersja w Piaskownicy może być nowsza niż w produkcji — sprawdź dwa razy.
Pierwsze 5 endpointów do przejrzenia
- POST /auth — jak się uwierzytelnić
- GET /sprawy — listowanie spraw (najprostszy GET, sprawdza autoryzację)
- POST /upload-token — jak dostać token do uploadu
- POST /files — upload pliku
- POST /rpw — dodanie dokumentu do RPW (typowy scenariusz)
Konsultacja architektury integracji
Pomożemy zaplanować integrację z API EZD RP — od czytania Swagger po testy w Piaskownicy.
Umów konsultację