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#
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:
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>
W przypadku żądań zawierających treść JSON uwzględnij także:
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żka | Cel |
|---|---|---|
POST | /product-import/products | Prześlij partię asynchronicznego importu produktów. |
GET | /product-import/products/status | Pobierz bieżące lub najnowsze zadanie importu. |
GET | /product-import/products | Lista aktualnych produktów sklepu. |
DELETE | /product-import/products | Logicznie usuń jeden produkt według identyfikatora produktu lub SKU. |
Przepływ importu wsadowego#
- Prześlij partię produktów za pomocą
POST /product-import/products. - Zapisz
jobIdzwrócony w odpowiedzi202 Accepted. - Odpytuj
GET /product-import/products/statusco 2 do 5 sekund. - Zatrzymaj odpytywanie, gdy status zmieni się na
completedlubfailed. - Jeśli zadanie ma status
completed, sprawdźfailedCountifailures, aby wykryć błędy dotyczące poszczególnych produktów.
W danym momencie dla sklepu może być aktywne tylko jedno zadanie importu.