Si vous créez une application qui se connecte à Omnisend, suivez les étapes ci-dessous pour comprendre l'API, choisir une méthode d'authentification, compléter votre intégration et la soumettre pour révision.
💡 Cet article se concentre sur le parcours des partenaires.Pour les détails de mise en œuvre, utilisez la documentation de l'API Omnisend.
Avant de commencer
Définissez ce que votre application fera avec les données Omnisend.Par exemple, votre application pourrait :
Synchroniser les contacts.
Récupérer des produits.
Envoyer des événements qui déclenchent des flux de travail d'automatisation.
Omnisend est une plateforme en libre-service.Vous n'avez pas besoin de demander un compte sandbox séparé pour le développement ou les tests.
Créez un compte Omnisend régulier et utilisez des données de test lors du développement de votre intégration.Vous pouvez créer un compte via le processus d'inscription standard d'Omnisend.
Processus de soumission
Étape 1. Examinez la documentation de l'API Omnisend
Commencez par Créer votre propre application.Ce guide explique comment les applications Omnisend sont structurées et quelles étapes sont nécessaires.
Ensuite, consultez le Guide de démarrage rapide.Il couvre les fondamentaux de l'API dont vous avez besoin pour le développement, y compris l'authentification, les points de terminaison et les formats de requête.
Identifiez les ressources API dont votre application a besoin :
Utilisez la Contacts API si votre application synchronise les données de contact.
Utilisez la Events API si votre application envoie des événements ou déclenche des flux de travail d'automatisation.
Utilisez la documentation de suivi des événements si votre intégration a besoin de données de comportement du site web, telles que les vues de page, les vues de produit ou les ajouts au panier.
Avant de continuer, documentez :
Ce que votre application enverra à Omnisend.
Ce que votre application récupérera.
Quelles autorisations elle nécessite.
Ce qui doit se passer lorsqu'une requête échoue.
Étape 2. Choisissez une méthode d'authentification
Choisissez entre une clé API et OAuth en fonction de la manière dont les utilisateurs se connecteront à votre application.
💡 Pour une application publique à laquelle plusieurs marchands se connecteront, Omnisend recommande OAuth.OAuth donne à chaque utilisateur un flux d'autorisation au lieu de leur demander de créer et de partager manuellement une clé API.
Pour mettre en œuvre OAuth, suivez les instructions d'authentification OAuth.Ensuite, soumettez le formulaire de demande d'identifiants OAuth.
Fournissez les informations demandées dans le formulaire.Omnisend fournira les identifiants et les informations dont vous avez besoin pour continuer.
Étape 3. Construisez et testez votre intégration.
Construisez et testez votre intégration avec un compte Omnisend régulier.Utilisez des données de test et examinez les résultats dans Paramètres de la boutique → Journaux API.Utilisez les journaux API pour déboguer les requêtes et confirmer que les données passent correctement.
Testez l'expérience utilisateur complète, y compris :
Autorisation.
Synchronisation des données.
Requêtes échouées.
Déconnexion.
Reconnaissance.
Si votre application envoie des contacts, des commandes, des produits, des paniers ou des événements, vérifiez que chaque ressource se comporte comme décrit dans votre liste du marché des applications.
Étape 4. Soumettez votre application terminée
Après avoir mis en œuvre et testé votre intégration, complétez le formulaire de soumission du marché des applications.
Incluez les informations demandées dans le formulaire, telles que :
Nom de l'application.
Description de l'application.
Catégorie.
Site web.
Logo.
Instructions de configuration.
Contact de support.
Méthode d'authentification.
Autorisations demandées.
Informations de test.
Si le formulaire demande des captures d'écran, des identifiants de test, des informations sur la confidentialité ou des détails de sécurité, fournissez-les avec votre soumission.Cela aide Omnisend à tester votre application.
Étape 5. Comprendre le processus de révision
Après avoir soumis le formulaire, Omnisend examine votre intégration et la liste proposée sur le marché des applications.
La révision vérifie si :
L'application fonctionne comme décrit.
L'application utilise les autorisations demandées de manière appropriée.
La liste fournit des instructions claires de configuration.
Omnisend peut vous contacter si des informations sont manquantes ou si votre intégration nécessite des modifications.
Si des modifications sont demandées, mettez à jour l'application ou la liste selon les instructions de l'équipe de révision.
Après que l'intégration a passé la révision :
Omnisend peut approuver et publier la liste sur le marché des applications.Les utilisateurs peuvent alors parcourir la liste et connecter l'application.
Omnisend rédige également un article de support dédié expliquant comment les commerçants peuvent intégrer votre application avec Omnisend.
Étape 6. Maintenez votre application après publication
Gardez votre intégration à jour après publication.Vérifiez vos autorisations avant de publier des modifications majeures et maintenez vos informations de contact de support à jour.
Si vous prévoyez d'améliorer l'intégration, faites-le savoir à Omnisend afin que le contenu de support connexe puisse être mis à jour.
FAQ
Dois-je utiliser une clé API ou OAuth ?
Choisissez la méthode d'authentification en fonction de la manière dont les utilisateurs se connecteront à votre application.OAuth est recommandé pour les applications publiques que plusieurs utilisateurs utiliseront.
Quelles informations devrais-je inclure dans ma soumission sur le marché des applications ?
Fournissez les informations demandées dans le formulaire de soumission, y compris le nom de votre application, la description, la catégorie, le site web, le logo, les instructions de configuration, le contact de support, la méthode d'authentification, les autorisations demandées et les informations de test.
Besoin d'aide avec Omnisend ? Contactez notre équipe de support via le chat intégré à l'application ou par email[email protected]. Notre équipe est disponible 24h/24 et 7j/7.