Modele danych#
Pojedynczy model danych w API zawiera zestaw informacji pochodzących z wybranego produktu z oferty MGBI.Każdy model ma określoną strukturę, którą opisujemy w sekcji Modele danych.Endpointy#
Pojedynczy endpoint API reprezentuje pojedynczą funkcję, którą można wykonać w API (np. pobranie rekordów, sprawdzenie dostępnych limitów).Endpointy dotyczące poszczególnych modeli danych opisujemy w sekcji Endpointy.Limity liczby operacji#
W ramach aktywnego dostępu użytkownik API może wykonanać określoną liczbę operacji na wybranych modelach danych.Dla każdego rodzaju operacji stosujemy osobny licznik i określamy maksymalnę liczbę jej wykonań w okresie abonamentowym.Każde poprawne wykonanie danej operacji zwiększa odpowiadający jej licznik o określoną wartość. Po przekroczeniu limitu dostępnej liczby wykonań operacji endpoint zwraca komunikat o błędzie.Znaczenie poszczególnych liczników oraz limitów podajemy w opisie odpowiedzi z endpointów Get Limits dla poszczególnych modeli danych.Projekcje#
W zależności od wybranego planu abonamentowego użytkownicy API otrzymują dostęp do całego dostępnego zakresu informacji w modelach danych albo tylko do wybranych pól.Zakres informacji w projekcjach dostępnych w ramach aktywnego planu abonamentowego podajemy w odpowiedzi z endpointów Get Projections dla poszczególnych modeli.Dla projekcji udostępnianych w niektórych planach abonamentowych obowiązują osobne liczniki i limity. Więcej informacji na ten temat uzyskasz u swojego opiekuna handlowego.Limitowanie listy wyników#
W odpowiedziach z endpointów API, które mogą zwracają listę rekordów, dzielimy wyniki na mniejsze porcje.Parametry umożliwiające korzystanie z paginacji podajemy w opisach parametrów w endpointach Get Records i Stream Records dla poszczególnych modeli danych.Pobieranie fragmentu listy rekordów możliwe jest na dwa sposoby:Paginacja#
Aby skorzystać z tej opcji, podaj w parametrach endpointu pola:page - numer strony wyników
per_page - liczba wyników na stronę
Przesunięcie i limit#
Aby skorzystać z tej opcji, podaj w parametrach endpointu pola:offset - numer rekordu, od którego chcesz rozpocząć listę wyników
limit - liczba zwracanych rekordów
Modified at 2025-02-27 21:07:28
