Ideal House Product Import API#
Usare Product Import API per importare, elencare ed eliminare logicamente i prodotti nel catalogo Ideal House. Le importazioni in blocco accettano da 1 a 500 prodotti e vengono elaborate in modo asincrono. Le operazioni di elenco ed eliminazione vengono elaborate in modo sincrono.
URL di base#
https://sdkapi.ideal.house
Utilizza HTTPS per tutte le richieste. I corpi delle richieste e delle risposte JSON sono codificati come UTF-8.
Prima di iniziare#
Ideal House fornirà i seguenti valori durante la configurazione iniziale:
- Shop ID
- Client ID
- Client Secret
Client ID e Client Secret sono credenziali lato server. Non esporre mai Client Secret nel codice del browser, nelle applicazioni mobili, nei repository pubblici, nei log o in altri ambienti lato client.
Autenticazione#
Includi queste intestazioni in ogni richiesta:
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>
Per le richieste con un corpo JSON, includere anche:
Content-Type: application/json
Il shopId nella richiesta deve corrispondere al negozio associato alle credenziali. In caso di mancata corrispondenza viene restituito 403 Forbidden.
Riepilogo dell'API#
| Metodo | Percorso | Scopo |
|---|---|---|
POST | /product-import/products | Invia un batch di importazione di prodotti asincrono. |
GET | /product-import/products/status | Ottieni il processo di importazione corrente o più recente. |
GET | /product-import/products | Elenca i prodotti attuali del negozio. |
DELETE | /product-import/products | Elimina logicamente un prodotto in base all'ID prodotto o allo SKU. |
Flusso di importazione batch#
- Invia un lotto di prodotto con
POST /product-import/products. - Salvare il
jobIdrestituito nella risposta202 Accepted. - Interrogare
GET /product-import/products/statusogni 2-5 secondi. - Interrompere le interrogazioni periodiche quando lo stato diventa
completedofailed. - Se l’attività è
completed, esaminarefailedCountefailuresper individuare errori relativi a singoli prodotti.
Per un negozio può essere attivo un solo lavoro di importazione alla volta.