Agencja Restrukturyzacji
i Modernizacji Rolnictwa

Dokumentacja Open API IRZplus

API IRZplus to zestaw usług dla posiadaczy zwierząt, za pomocą których możliwe jest składanie dokumentów w zakresie IRZ, przegląd danych zwierząt i zdarzeń zwierzęcych, przegląd danych działalności (siedzib stad) oraz złożonych dokumentów IRZ.

API IRZplus pozwala na obsługę dokumentów oraz przegląd danych dotyczących bydła, owiec, kóz, świń, jeleniowatych, wielbłądowatych, koniowatych oraz drobiu. 

Udostępniona dokumentacja Open API systemu IRZplus obejmuje informacje niezbędne do integracji systemów zewnętrznych z systemem IRZplus.

Dokumentacja Open API została podzielona na obszary:

WSPÓLNE

Dokumentacja opisuje sposób uwierzytelniania i autoryzacji w systemie IRZplus oraz pobieranie wartości słownikowych niezbędnych do korzystania z usług API.

Zakres obejmuje:

• uzyskiwanie dostępu do API,
• mechanizm autoryzacji,
• przekazywanie tokenów dostępowych,
• wymagane nagłówki HTTP,
• kody odpowiedzi związane z autoryzacją,
• przykładowe wywołania.

Przykładowe słowniki obejmują:

• gatunki zwierząt,
• rasy,
• typy zdarzeń,
• rodzaje dokumentów,
• statusy oraz inne wartości słownikowe wykorzystywane przez poszczególne usługi API.

PRODUCENT

Dokumentacja opisuje usługi API umożliwiające wymianę danych z systemem IRZplus.

Zakres udostępnianych usług obejmuje:

• składanie dokumentów dotyczących zdarzeń zwierzęcych,
• pobieranie listy złożonych dokumentów,
• pobieranie listy danych zdarzeń zwierzęcych,
• pobieranie listy danych zwierząt,
• pobieranie danych działalności,
• opis struktur komunikatów, parametrów wejściowych i odpowiedzi,
• przykładowe wywołania usług API oraz kody odpowiedzi.

Dokumentacja Open API