/
Création et publication d'intégrations sur Esadax
Table des matières
- Introduction
- Comprendre les intégrations natives
- Création d'une intégration
- Détails du formulaire d'intégration
- Création d'une intégration de produit
- Après la création de l'intégration
- Affichage et gestion des intégrations
- Intégrations de comptes connectables
- Badge communautaire et intégrations communautaires
- Meilleures pratiques de flux d'installation
- [Assistance à l'intégration] (#integration-support)
- Conclusion
I. INTRODUCTION
L'intégration avec Esadax offre un moyen puissant d'améliorer votre application ou votre service. Que vous construisiez pour un usage interne ou que vous publiiez un outil pour d'autres, ce guide vous guidera à travers chaque étape de la création, de la gestion et de l'optimisation de votre intégration, avec les meilleures pratiques pour assurer une expérience fluide à vos utilisateurs.
Comprendre les intégrations natives
Les intégrations natives sont des citoyens de première classe dans l’écosystème Esadax, offrant une intégration directe et transparente avec les fonctionnalités de la plateforme.
Principaux avantages:
- Aucun middleware requis — Prise en charge native depuis la plateforme Esadax.
- Temps de développement réduit — Composants prédéfinis et configuration simplifiée.
- Expérience développeur renforcée — Documentation complète et prise en charge des plateformes.
Vous pouvez également choisir de créer des intégrations personnalisées si votre cas d'utilisation nécessite des services externes ou des API.
Créer une intégration
Pour commencer:
- Accédez à la console Intégrations.
- Cliquez sur Créer une intégration.
- Remplissez le formulaire avec les informations de base de votre intégration (voir la section suivante).
Détails du formulaire d'intégration
Lorsque vous remplissez le formulaire d'intégration, fournissez:
- Nom : Un identifiant unique pour votre intégration.
- Description : Une brève explication de ce que fait votre intégration.
- Type d’intégration : Choisissez entre « Natif » et « Personnalisé ».
- Paramètres de visibilité : Définissez qui peut voir ou utiliser l'intégration.
- Support Email: Fournir les coordonnées pour le soutien.
- Lien de documentation (facultatif): Aidez les utilisateurs à comprendre comment l'installer et l'utiliser.
- Bouton de déploiement * (facultatif) *: Ajoutez un bouton pour déployer automatiquement l'intégration à partir de Git.
Création d'une intégration de produit
Lorsque votre intégration implique un produit installable, vous devez :
- Fournir un flux d'installation clair qui s'adapte aux nouveaux utilisateurs et aux utilisateurs existants.
- Inclure une documentation concise pour l'installation et l'utilisation.
- Définissez des paramètres par défaut qui fonctionnent immédiatement tout en permettant une personnalisation.
- Utilisez versioning dans votre formulaire pour aider à suivre les mises à jour et la rétrocompatibilité.
Création après intégration
Une fois publié, vous pouvez:
- Surveiller les journaux en utilisant le bouton Afficher les journaux dans la console d'intégration.
- État de mise à jour : Suivez les mesures d'installation, les erreurs et les modifications de version.
- Affinez votre intégration : Itérez en fonction des commentaires des utilisateurs ou des tests.
Affichage et gestion des intégrations
Dans Integrations Console, vous pouvez:
- Affichez la liste de vos intégrations.
- Accédez aux détails, y compris les URL actives, les journaux d'installation et l'état de visibilité.
- Filtrez les journaux par type de demande (par exemple, erreurs, installations).
Intégrations de compte connectables
Si votre intégration connecte des services externes (par exemple, analyse, authentification, commerce électronique):
- Activez des workflows sécurisés de liaison de comptes.
- Prise en charge des scénarios multi-comptes (individuel vs. www.who.int).
- Valider les jetons et les identités selon le modèle de sécurité partagé d’Esadax.
Badge communautaire et intégrations communautaires
- Les intégrations soumises par des développeurs externes reçoivent un badge de la communauté, les marquant comme prises en charge par des tiers.
- Ceux-ci peuvent apparaître sur le marché avec une étiquette claire.
- Avant d’installer une intégration communautaire, les utilisateurs doivent consulter les documents suivants du développeur :
- Politique de confidentialité
- Conditions d'utilisation
- Détails de soutien
Meilleures pratiques de flux d'installation
Concevoir une expérience d’installation intuitive améliore l’adoption.
Débit recommandé:
- Nouveaux utilisateurs:
- Guider à travers la création de compte dans le processus d'installation.
- Utilisateurs de retour:
- Permettre une connexion transparente sans perdre la progression de l'installation.
- Erreur de récupération:
- Gérez facilement les réinitialisations de mot de passe et les sessions expirées.
- Valeurs par défaut:
- Préconfigurez des paramètres raisonnables pour minimiser les entrées requises.
- Options avancées:
- Fournissez-les, mais cachez-les derrière une section à bascule ou extensible.
Soutien à l'intégration
Vous êtes responsable du support continu de votre intégration:
- Répondez rapidement aux problèmes via votre e-mail d'assistance.
- Incluez des conseils de dépannage et des limitations connues dans votre documentation.
- Envisagez de configurer des journaux de modification versionnés pour communiquer clairement les mises à jour.
IV. CONCLUSION
En suivant ce guide, vous pouvez fournir une intégration fiable et conviviale pour la plate-forme Esadax. Que vous étendiez les workflows internes ou que vous construisiez des outils pour la communauté, une conception d'intégration réfléchie - de la structure du formulaire au flux utilisateur - garantit que votre travail est réussi et évolutif.
