Ideal House
Przejdź do treści

Ideal House Product Import API#

Używaj Product Import API do importowania, wyświetlania listy i logicznego usuwania produktów w katalogu Ideal House. Import wsadowy przyjmuje od 1 do 500 produktów i jest przetwarzany asynchronicznie. Operacje wyświetlania listy i usuwania są wykonywane synchronicznie.

Bazowy adres URL#

text
https://sdkapi.ideal.house

Używaj protokołu HTTPS do wszystkich żądań. Treści żądań i odpowiedzi JSON są kodowane w formacie UTF-8.

Zanim zaczniesz#

Ideal House przekaże następujące wartości podczas wdrożenia:

  • Shop ID
  • Client ID
  • Client Secret

Client ID i Client Secret to dane uwierzytelniające używane po stronie serwera. Nigdy nie ujawniaj Client Secret w kodzie przeglądarki, aplikacjach mobilnych, publicznych repozytoriach, logach ani innych środowiskach klienckich.

Uwierzytelnianie#

Dołącz te nagłówki do każdego żądania:

http
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>

W przypadku żądań zawierających treść JSON uwzględnij także:

http
Content-Type: application/json

Wartość shopId w żądaniu musi odpowiadać sklepowi powiązanemu z danymi uwierzytelniającymi. W przeciwnym razie API zwróci 403 Forbidden.

Podsumowanie API#

MetodaŚcieżkaCel
POST/product-import/productsPrześlij partię asynchronicznego importu produktów.
GET/product-import/products/statusPobierz bieżące lub najnowsze zadanie importu.
GET/product-import/productsLista aktualnych produktów sklepu.
DELETE/product-import/productsLogicznie usuń jeden produkt według identyfikatora produktu lub SKU.

Przepływ importu wsadowego#

  1. Prześlij partię produktów za pomocą POST /product-import/products.
  2. Zapisz jobId zwrócony w odpowiedzi 202 Accepted.
  3. Odpytuj GET /product-import/products/status co 2 do 5 sekund.
  4. Zatrzymaj odpytywanie, gdy status zmieni się na completed lub failed.
  5. Jeśli zadanie ma status completed, sprawdź failedCount i failures, aby wykryć błędy dotyczące poszczególnych produktów.

W danym momencie dla sklepu może być aktywne tylko jedno zadanie importu.