W Swaggerze udostępniona została publicznie dokumentacja API EZD RP. Integratorzy mają tu bezpośredni dostęp do pełnego opisu metod API bez konieczności wcześniejszego kontaktu z zespołem Piaskownicy API EZD RP. Dokumentacja na platformie Swagger dostępna jest dla:
Aby wybrać wersję integratora, należy kliknąć ikonę rozwijania w polu Select a definition, które znajduje się w prawym górnym rogu, i wskazać właściwą pozycję z listy.
Uwaga! Środowisko Demo EZD RP, na którym dostępna jest dokumentacja, nie umożliwia generowania kluczy ani korzystania z metod API – służy wyłącznie do zapoznania się z dokumentacją.
Przygotowanie dokumentacji w formacie OpenAPI 3.0 i jej udostępnienie poprzez Swaggera ułatwia eksplorację, testowanie oraz integrację. Dzięki temu można szybko zapoznać się ze strukturą punktów końcowych (endpoints) i ich parametrami, a także wygodnie testować zapytania bezpośrednio w przeglądarce.
Taka możliwość istnieje po uzyskaniu dostępu do środowiska Piaskownicy API EZD RP dla integratorów. Szczegóły dotyczące rozpoczęcia współpracy znajdują się w artykule Piaskownica API opublikowanym w Portalu EZD RP. Proces rozpoczyna się od wypełnienia formularza z podstawowymi informacjami o wnioskującym podmiocie. We wniosku należy jasno wskazać potrzeby – zarówno biznesowe (np. poznanie systemu EZD), jak i techniczne. Ułatwi to określenie zakresu planowanej integracji.
Uwaga! Informacje zawarte w artykule Przykłady użycia metod API EZD RP należy traktować jako dokumentację dla pierwszej wersji (v1) interfejsu API EZD RP.