Ogólne informacje

Aktualizacja danych w MGBI API

Modele danych dostępne w MGBI API dzielimy na dwie grupy:

1. Modele synchronizowane w czasie rzeczywistym
Dla tych modeli dysponujemy pełną i codziennie aktualizowaną (co najmniej raz na dobę) kopią wszystkich rekordów dostępnych w źródle.

2. Modele synchronizowane na żądanie
Modele z tej grupy opierają się na źródłach nie umożliwiających stałej aktualizacji kompletu dostępnych w nich informacji.

Aby zagwarantować aktualność danych w modelach z drugiej grupy, udostępniliśmy w MGBI API opisany poniżej mechanizm odświeżania danych.

Modele z obsługą odświeżania danych

Model danych	Obsługiwane identyfikatory
`pl-wpv-record`	`pl_nip`
`pl-crbr-wp-record`	`pl_nip`
`pl-krz-wp-record`	`pl_nip`, `pl_pesel`, `sygnatura`

Proces odświeżania danych

1. Utworzenie zlecenia odświeżenia danych

Aby utworzyć zlecenie odświeżenia danych, należy użyć endpointu Create Refresh i wskazać w nim model oraz identyfikator, który będzie użyty do wyszukania danych w źrodle:

{
    "query": {
        "model": [identyfikator modelu],
        "identifiers.pl_nip": [numer NIP]
    }
}

Po zarejestrowaniu zlecenia endpoint zwraca jego parametry:

{
    "id": [identyfikator zlecenia],
    "query": {
        "model": [identyfikator modelu],
        "identifiers.pl_nip": [numer NIP]
    },
    "creation_datetime": [data i czas utworzenia zlecenia],
    "status": [aktualny status zlecenia]
}

Nowe zlecenie powinno zostać wykonane w czasie od kilku do kilkudziesięciu sekund od momentu jego utworzenia.

2. Pobieranie statusu zlecenia

Aby sprawdzić status zlecenia odświeżenia danych, należy użyć endpointu Get Refresh podając w parametrze id uzyskany w poprzednim kroku identyfikator zlecenia.

W odpowiedzi endpoint zwraca aktualne parametry zlecenia:

{
    "id": [identyfikator zlecenia],
    "query": {
        "model": [identyfikator modelu],
        "identifiers.pl_nip": [numer NIP]
    },
    "creation_datetime": [data i czas utworzenia zlecenia],
    "start_datetime": [data i czas rozpoczęcia wykonywania zlecenia],
    "finish_datetime": [data i czas zakończenia wykonywania zlecenia],
    "status": [aktualny status zlecenia]
}

Jeśli parametr status przyjmuje wartość success, oznacza to, że zlecenie odświeżenia danych zakończyło się sukcesem.

3. Pobieranie odświeżonych danych

Aby pobrać odświeżone rekordy z danymi, należy użyć endpointu Get Records lub Stream Records dla wybranego modelu i przekazać w parametrze refresh_id identyfikator zlecenia odświeżenia danych.

Aktualizacja danych w MGBI API#

Modele z obsługą odświeżania danych#

Proces odświeżania danych#

1. Utworzenie zlecenia odświeżenia danych#