Vue d'ensemble
L'API ShopiMind est une API REST qui permet à votre boutique d'échanger en temps réel avec la plateforme ShopiMind : synchroniser vos données e-commerce, enrichir les profils de contact avec des informations issues d'outils tiers, et déclencher des scénarios d'automatisation marketing depuis n'importe quelle application.
À quoi sert cette API
Trois cas d'usage majeurs justifient son utilisation.
Développer un connecteur e-commerce sur mesure
Si votre boutique utilise une plateforme non couverte par les connecteurs officiels ShopiMind — solution propriétaire, CMS interne, marketplace privée — vous pouvez bâtir votre propre synchronisation : pousser vos clients (customers), commandes, produits, paniers et catalogues directement dans ShopiMind via les endpoints REST dédiés. Les ressources couvrent l'ensemble du modèle e-commerce et leurs relations.
Enrichir les profils avec des données personnalisées
Vous pouvez définir vos propres schémas de données via les Custom data definitions puis y pousser des enregistrements via Custom data records. Ces données peuvent provenir de n'importe quel outil tiers : ERP, CRM, plateforme de fidélité, application métier interne. Une fois ingérées, elles deviennent immédiatement exploitables côté ShopiMind dans la segmentation, les filtres, les déclencheurs de scénarios et le contenu dynamique des messages.
Déclencher des automatisations depuis un outil externe
Vous pouvez déclarer des types d'événements externes côté ShopiMind, puis les émettre depuis n'importe quel système tiers via un appel API. Chaque émission active les scénarios d'automatisation marketing abonnés à cet événement — e-mail transactionnel, séquence de relance, notification, scénario multicanal, etc. C'est la voie privilégiée pour relier des événements métier (achat en boutique physique, signature d'un devis, fin d'un abonnement, demande de SAV…) à un parcours marketing ShopiMind.
Customers et contacts
Distinction fondamentale du modèle ShopiMind :
- Un customer est un enregistrement e-commerce que vous synchronisez depuis une source de données (boutique en ligne, magasin physique, import CSV, formulaire popup, etc.). Plusieurs customers peuvent coexister pour une même personne — un par source — et partager le même email.
- Un contact est le profil unifié qui regroupe tous les customers d'une même personne. Les contacts ne sont jamais créés directement via l'API : ShopiMind les génère et les maintient automatiquement à mesure que vous poussez des customers (le rapprochement s'appuie principalement sur l'email et le numéro de téléphone). Ce sont les contacts qui alimentent ensuite la segmentation, les filtres, les déclencheurs de scénarios et les envois.
En pratique, votre intégration pousse des customers ; ShopiMind dérive et maintient les contacts. Les endpoints Contacts exposés dans la référence sont en lecture seule — ils servent à interroger l'état des profils unifiés côté ShopiMind.
Comment l'API fonctionne
L'API suit les conventions REST. Toutes les requêtes utilisent le format JSON en entrée et en sortie, et sont authentifiées via une clé API à passer dans le header spm-api-key de chaque requête.
Base URL
Toutes les requêtes API sont faites vers : https://core.shopimind.com/v1
Les opérations d'écriture en lot (POST, PUT, bulk-delete) sont traitées de manière asynchrone. Un code 200 signifie que votre requête a été acceptée et mise en file de traitement, pas que l'effet est immédiatement visible sur les lectures suivantes. La latence de prise en compte est typiquement de quelques secondes.
Codes HTTP
| Code | Signification |
|---|---|
200 | Succès — requête acceptée et, pour les écritures bulk, mise en file de traitement. |
400 | Requête invalide — payload mal formé, paramètres manquants, dépassement de la taille de batch. |
401 | Authentification manquante ou invalide. |
403 | Accès refusé — la clé API n'a pas les droits pour cette opération. |
404 | Ressource introuvable. |
429 | Limite de débit atteinte (voir ci-dessous). |
5XX | Erreur côté serveur — contactez le support si elle persiste. |
Limites de débit
L'API applique une limite de 600 requêtes par minute par clé API. Au-delà, les requêtes reçoivent un code 429. Pour les imports volumineux, privilégiez les endpoints bulkCreate* / bulkUpdate* (jusqu'à 50 ou 100 enregistrements par appel selon la ressource) : un seul appel suffit pour traiter plusieurs entités, ce qui réduit drastiquement la consommation de votre quota.