+POST/api/v1/queues/:queue_name/pop
Pobiera dane z kolejki
Pobiera dane z kolejki
:queue_name,
gdzie
:queue_name
może przyjmować wartości 'meta' lub 'stocks'.
W treści żądania można przekazać trzy argumenty:
count
,
testing
oraz
offset
(tylko gdy testing=1)
.
Parametr
count
jest opcjonalny i oznacza maksymalną ilość produktów, które jednorazowo zdejmujemy z kolejki.
API akceptuje wartość
count
pomiędzy 1 i 100.
Wymagane jest natomiast podanie nagłówka HTTP X-eLibri-API-ONIX-dialect . Obecnie może on przyjmować wartość: 3.0.1
Gdy parametr testing ma wartość 1, dane nie są w rzeczywistości usuwane z kolejki oczekującej. Taki request można wykonywać wielokrotnie i za każdym razem zwraca te same dane (dane produktów z początku kolejki oczekującej).
Aby uprościć parsowanie odpowiedzi (brak konieczności dodatkowych przestrzeni nazw w XML`u), metadane POP`u zostały przeniesione do nagłówków HTTP. Wykorzystywane są do tego celu nagłówki X-eLibri-API-pop-* Gdy X-eLibri-API-pop-products-count równe jest 0, odpowiedź od serwera nie zawiera żadnych danych. Oznacza to iż pobraliśmy już wszystkie dane z kolejki. Parametr offset może być używany tylko w połączeniu z parametrem testing=1, i pozwala na przeglądanie całej kolejki, bez jej modyfikowania. Domyślnie parametr ten przyjmuje wartość 0, czyli zwracane są dane z początku kolejki.
Wymagane jest natomiast podanie nagłówka HTTP X-eLibri-API-ONIX-dialect . Obecnie może on przyjmować wartość: 3.0.1
Gdy parametr testing ma wartość 1, dane nie są w rzeczywistości usuwane z kolejki oczekującej. Taki request można wykonywać wielokrotnie i za każdym razem zwraca te same dane (dane produktów z początku kolejki oczekującej).
Aby uprościć parsowanie odpowiedzi (brak konieczności dodatkowych przestrzeni nazw w XML`u), metadane POP`u zostały przeniesione do nagłówków HTTP. Wykorzystywane są do tego celu nagłówki X-eLibri-API-pop-* Gdy X-eLibri-API-pop-products-count równe jest 0, odpowiedź od serwera nie zawiera żadnych danych. Oznacza to iż pobraliśmy już wszystkie dane z kolejki. Parametr offset może być używany tylko w połączeniu z parametrem testing=1, i pozwala na przeglądanie całej kolejki, bez jej modyfikowania. Domyślnie parametr ten przyjmuje wartość 0, czyli zwracane są dane z początku kolejki.
200
- X-eLibri-API-pop-created-at:
- 2011-10-04 12:02:07 UTC
- X-eLibri-API-pop-products-count:
- 20
- X-eLibri-API-pop-queue-name:
- meta
<ONIXMessage xmlns:elibri="http://elibri.com.pl/ns/extensions" xmlns="http://www.editeur.org/onix/3.0/reference" release="3.0"> <elibri:Dialect>3.0.1</elibri:Dialect> <Header> <Sender> <SenderName>Elibri.com.pl</SenderName> <ContactName>Tomasz Meka</ContactName> <EmailAddress>kontakt@elibri.com.pl</EmailAddress> </Sender> <SentDateTime>20110906</SentDateTime> </Header> <Product> <!-- [...] --> </Product> <Product> <!-- [...] --> </Product> </ONIXMessage>
curl -i -k --digest -u $ELIBRI_API_LOGIN:$ELIBRI_API_PASSWORD \ -H "X-eLibri-API-ONIX-dialect: 3.0.1" \ -d "count=1&testing=1" -X POST \ https://www.elibri.com.pl/api/v1/queues/meta/pop
+POST/api/v1/queues/refill_all
Wypełnij kolejki
Użyteczne w przypadku konieczności pełnej synchronizacji z eLibri. Kolejki są wypełniane
danymi o wszystkich produktach.
curl -i -k --digest -u $ELIBRI_API_LOGIN:$ELIBRI_API_PASSWORD \ -X POST \ https://www.elibri.com.pl/api/v1/queues/refill_all