API przyjmuje parametry wysłane w formacie JSON. Sukces lub błąd obsługi żądania sygnalizowany jest odpowiednim kodem HTTP zwracanej odpowiedzi. Kod HTTP 200 oznacza poprawną realizację żądania, inne kody oznaczają błąd adekwatny do zgłoszonego kodu, np. HTTP 401 - błąd autoryzacji.

Komunikacja

API dostępne jest wyłącznie z użyciem protokołu HTTPS pod adresem api.100shoppers.click.

Autoryzacja

Każde zapytanie wymaga autoryzacji wykorzystującej API * Key (APIkey)* i *APIsecret (APIsecret)*, które można wygenerować samodzielnie w ramach panelu administracyjnego. Mechanizm autoryzacji wykorzystuje nagłówek X-BB-API-Authorization, w którym należy przekazać sekwencję zbudowaną zgodnie z poniższym wzorcem.

X-BB-API-Authorization: APIkey:signature
signature = HMAC-SHA1( APIsecret, UTF-8-Encoding-Of( stringToSign ) ) );
stringToSign = HTTP-VERB + " " + requestPath + "\n" + JSONPayload;

Ważne

Maksymalna liczba aktualizowanych rekordów w jednym pakiecie to 200, podczas gdy pakietów może być wiele.

Przykład zapytania

POST https://api.buybox.click/api/v1/campaigns/{campaignId}/offers
X-BB-API-Authorization: APIkey:signature
Content-Type: application/json
{
  "offers":
    [
      {
        "id":"1001",
        "url":"https://offers.io/offer-1",
        "price":9.90,
        "available":true
      },{
        "id":"1002",
        "url":"https://offers.io/offer-2",
        "price":10.99,
        "available":true
        }
    ]
}

Odpowiedź

Content-Type: application/json {"result":"OK"}