Ideal House
Aller au contenu principal

Ideal House Product Import API#

Utilisez la Product Import API pour importer, lister et supprimer logiquement les produits de votre catalogue Ideal House. Les imports par lots acceptent de 1 à 500 produits et sont traités de manière asynchrone. Les opérations de liste et de suppression sont traitées de manière synchrone.

URL de base#

text
https://sdkapi.ideal.house

Utilisez HTTPS pour toutes les requêtes. Les corps de requête et de réponse JSON sont encodés en UTF-8.

Avant de commencer#

Ideal House fournira les valeurs suivantes lors de l'intégration :

  • Un Shop ID
  • Un Client ID
  • Un Client Secret

Le Client ID et le Client Secret sont des identifiants côté serveur. Ne jamais exposer le Client Secret dans le code navigateur, les applications mobiles, les dépôts publics, les journaux ou tout autre environnement côté client.

Authentification#

Incluez ces en-têtes avec chaque requête :

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

Pour les requêtes avec un corps JSON, incluez également :

http
Content-Type: application/json

Le shopId dans la requête doit correspondre à la boutique associée aux identifiants. Une incompatibilité renvoie 403 Forbidden.

Résumé de l'API#

MéthodeCheminObjectif
POST/product-import/productsSoumettre un lot d'importation de produit asynchrone.
GET/product-import/products/statusObtenir la tâche d'importation en cours ou la plus récente.
GET/product-import/productsLister les produits actuels de la boutique.
DELETE/product-import/productsSupprimer logiquement un produit par Product ID ou SKU.

Flux d'importation par lot#

  1. Soumettez un lot de produit avec POST /product-import/products.
  2. Conservez le jobId renvoyé dans la réponse 202 Accepted.
  3. Interrogez périodiquement GET /product-import/products/status toutes les 2 à 5 secondes.
  4. Arrêtez le sondage lorsque le statut devient completed ou failed.
  5. Si la tâche est completed, inspectez failedCount et failures pour les erreurs au niveau des éléments.

Une seule tâche d'importation peut être active pour une boutique à la fois.