Aller au contenu

Intégration API de l'inventaire

Si vous avez un système de gestion d'inventaire qui peut envoyer des données automatiquement, vous pouvez utiliser notre API pour garder votre inventaire Voxum synchronisé.

Note

Cette section contient des informations techniques. Vous devrez peut-être la partager avec votre équipe informatique ou développeur.

Quand utiliser l'intégration API

Utilisez l'intégration API quand :

  • Votre inventaire change fréquemment (quotidiennement ou plus)
  • Vous avez un système qui peut envoyer des requêtes HTTP
  • Vous voulez des mises à jour automatisées sans téléversements manuels de fichiers
  • Vous gérez un grand inventaire

Pour des mises à jour occasionnelles, le téléversement de fichier peut être plus simple.

Aperçu de l'API

Voxum supporte deux formats de données pour l'intégration d'inventaire :

  • JSON - JavaScript Object Notation
  • XML - Extensible Markup Language

Les deux accomplissent la même chose—choisissez celui que votre système supporte.

Trouver vos informations API

  1. Allez à Inventaire dans le menu de gauche
  2. Faites défiler jusqu'à la section Intégration API
  3. Vous trouverez :
  4. L'URL de votre point de terminaison API
  5. Votre ID de propriété
  6. Exemple de format de requête

Informations API

Authentification API

Vos requêtes API doivent inclure votre clé API pour l'authentification.

Obtenir une clé API

  1. Allez à Clés API dans le menu de gauche
  2. Cliquez sur Créer une clé API
  3. Donnez-lui un nom (ex. « Intégration inventaire »)
  4. Copiez et stockez la clé en sécurité

En savoir plus sur les clés API →

Inclure la clé API

Ajoutez votre clé API dans l'en-tête de la requête :

X-API-Key: votre-cle-api-ici

Format JSON

Point de terminaison

POST https://app.voxum.ai/api/inventory

En-têtes de requête

Content-Type: application/json
X-API-Key: votre-cle-api-ici

Exemple de charge JSON

{
  "items": [
    {
      "id": "SKU001",
      "name": "Honda Accord 2024",
      "category": "Berline",
      "price": 32500,
      "description": "Berline neuve avec caractéristiques de sécurité avancées",
      "attributes": {
        "year": "2024",
        "make": "Honda",
        "model": "Accord",
        "color": "Blanc",
        "mileage": 0
      },
      "available": true,
      "url": "https://votresite.com/vehicules/sku001",
      "image": "https://votresite.com/images/accord.jpg"
    },
    {
      "id": "SKU002",
      "name": "Toyota RAV4 2023",
      "category": "VUS",
      "price": 29800,
      "description": "VUS populaire avec excellente fiabilité",
      "attributes": {
        "year": "2023",
        "make": "Toyota",
        "model": "RAV4",
        "color": "Bleu",
        "mileage": 15000
      },
      "available": true,
      "url": "https://votresite.com/vehicules/sku002"
    }
  ]
}

Référence des champs JSON

Champ Type Requis Description
id string Oui Identifiant unique
name string Oui Nom d'affichage
category string Non Catégorie ou type
price number Non Prix (sans symbole de devise)
description string Non Description de l'article
attributes object Non Paires clé-valeur personnalisées
available boolean Non En stock ou disponible
url string Non Lien vers la page de détail
image string Non URL de l'image

Format XML

Point de terminaison

POST https://app.voxum.ai/api/inventory

En-têtes de requête

Content-Type: application/xml
X-API-Key: votre-cle-api-ici

Exemple de charge XML

<?xml version="1.0" encoding="UTF-8"?>
<inventory>
  <item>
    <id>SKU001</id>
    <name>Honda Accord 2024</name>
    <category>Berline</category>
    <price>32500</price>
    <description>Berline neuve avec caractéristiques de sécurité avancées</description>
    <attributes>
      <year>2024</year>
      <make>Honda</make>
      <model>Accord</model>
      <color>Blanc</color>
      <mileage>0</mileage>
    </attributes>
    <available>true</available>
    <url>https://votresite.com/vehicules/sku001</url>
    <image>https://votresite.com/images/accord.jpg</image>
  </item>
  <item>
    <id>SKU002</id>
    <name>Toyota RAV4 2023</name>
    <category>VUS</category>
    <price>29800</price>
    <description>VUS populaire avec excellente fiabilité</description>
    <attributes>
      <year>2023</year>
      <make>Toyota</make>
      <model>RAV4</model>
      <color>Bleu</color>
      <mileage>15000</mileage>
    </attributes>
    <available>true</available>
    <url>https://votresite.com/vehicules/sku002</url>
  </item>
</inventory>

Codes de réponse

Code Signification
200 Succès - inventaire mis à jour
400 Mauvaise requête - vérifiez votre format de données
401 Non autorisé - vérifiez votre clé API
413 Charge trop grande - réduisez la taille du lot
500 Erreur serveur - réessayez plus tard

Bonnes pratiques

Mises à jour par lots

  • Envoyez l'inventaire complet à chaque requête
  • N'envoyez pas les articles individuellement un à la fois
  • Lot maximum recommandé : 10 000 articles

Fréquence de mise à jour

  • Le temps réel n'est pas requis pour la plupart des cas d'utilisation
  • Les mises à jour horaires ou quotidiennes sont généralement suffisantes
  • Des mises à jour plus fréquentes augmentent la charge du serveur

Gestion des erreurs

  • Journalisez les réponses API pour le dépannage
  • Implémentez une logique de réessai pour les échecs
  • Alertez sur les échecs répétés

Qualité des données

  • Validez les données avant d'envoyer
  • Assurez-vous que les prix sont des nombres
  • Vérifiez que les URLs sont accessibles

Tester votre intégration

  1. Créez une clé API de test
  2. Envoyez un petit lot (5-10 articles)
  3. Vérifiez la réponse
  4. Testez votre chatbot avec des questions d'inventaire
  5. Passez à l'échelle une fois confirmé que ça fonctionne

Obtenir de l'aide

Si vous avez besoin d'aide avec l'intégration API :

  1. Révisez les exemples ci-dessus
  2. Vérifiez les codes de réponse pour des indices d'erreur
  3. Vérifiez que votre clé API est active
  4. Contactez le support avec des messages d'erreur spécifiques

Prochaines étapes