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#
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 :
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>
Pour les requêtes avec un corps JSON, incluez également :
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éthode | Chemin | Objectif |
|---|---|---|
POST | /product-import/products | Soumettre un lot d'importation de produit asynchrone. |
GET | /product-import/products/status | Obtenir la tâche d'importation en cours ou la plus récente. |
GET | /product-import/products | Lister les produits actuels de la boutique. |
DELETE | /product-import/products | Supprimer logiquement un produit par Product ID ou SKU. |
Flux d'importation par lot#
- Soumettez un lot de produit avec
POST /product-import/products. - Conservez le
jobIdrenvoyé dans la réponse202 Accepted. - Interrogez périodiquement
GET /product-import/products/statustoutes les 2 à 5 secondes. - Arrêtez le sondage lorsque le statut devient
completedoufailed. - Si la tâche est
completed, inspectezfailedCountetfailurespour les erreurs au niveau des éléments.
Une seule tâche d'importation peut être active pour une boutique à la fois.