Pratiques exemplaires
Pour assurer une expérience utilisateur positive en plus d’augmenter les chances que votre application soit approuvée et intégrée à l’App Directory, nous vous suggérons d’adopter les pratiques exemplaires énoncées ci-dessous.

Vous trouverez de plus amples détails à ce sujet dans les guides de notre site Web, mais nous les avons regroupés ici pour faciliter leur consultation.

Conception de votre application

  • Les clients de Yext doivent s’assurer de l’exactitude des données relatives à leur marque et tirer profit de ces données pour apporter de la valeur à leur entreprise. En tant que développeur, vous devez garder ce public cible en tête lorsque vous créez des applications. Et surtout, l’installation et l’utilisation de votre application ne doivent pas exiger des connaissances techniques poussées ni l’implication de divers intervenants.
  • Chaque application ne doit exécuter qu’un seul cas d’utilisation à clé unique pour passer du Knowledge Engine de Yext à une plateforme externe.
  • Si vous utilisez l’image de marque de Yext dans votre application, veuillez respecter nos directives en matière d’image de marque, telles que décrites sur Brandfolder et utiliser les ressources qui y sont fournies.

Processus OAuth

  • Nous avons mis en place le protocole normalisé OAuth 2.0 pour l’authentification et l’autorisation d’accès. La redirection vers notre flux OAuth nous permet d’authentifier de façon sécuritaire les utilisateurs et de les inviter à accepter ou à refuser les autorisations de votre application. Pour obtenir de plus amples renseignements, veuillez consulter OAuth et portées des autorisations.
  • Nous suggérons fortement d’utiliser un flux OAuth pour l’authentification et les autorisations des utilisateurs dans d’autres plateformes. Si le protocole OAuth n’est pas intégré à la plateforme en question, votre application peut demander que l’utilisateur fournisse une clé API statique. Cette méthode est vivement déconseillée, puisqu’elle entraîne des incidences négatives sur l’expérience utilisateur et peut accorder à votre application plus d’autorisations que nécessaire.
  • Nous recommandons d’utiliser une fenêtre surgissante de 470 x 600 pixel pour recueillir les données d’authentification du client.
  • En général, les applications n’ont pas un magasin de données utilisateur distinct; nous conseillons d’utiliser un seul identificateur de compte dans Yext et la plateforme externe pour établir le contexte utilisateur. La configuration de l’application peut être liée au contexte utilisateur en question. Grâce à cette méthode, l’utilisateur obtient la même configuration lorsqu’il utilise l’authentification et l’autorisation pour les comptes Yext et externe correspondant, et ce, peu importe les identifiants actuels. Pour en apprendre davantage à ce sujet, veuillez consulter la documentation sur les identificateurs Yext.
  • Les jetons d’accès doivent être stockés de façon sécuritaire (c’est-à-dire chiffrés en état d’inactivité), puisqu’ils sont analogues aux mots de passe des utilisateurs. N’utilisez en aucun cas le jeton d’accès hors d’une connexion sécurisée avec Yext lors d’appels API.

Champs personnalisés

Votre préfixe de champ personnalisé doit être une courte chaîne unique orientée vers l’utilisateur entre 3 et 50 caractères. Cette chaîne comporte généralement le nom de la plateforme externe qui est intégrée à votre application (p. ex. « Zendesk », « Salesforce » ou « Hubspot »). Si votre comportement de champ personnalisé est « Enabled for fields with prefix », toutes les définitions de champ personnalisé que vous gérez dans votre application doivent commencer par cette chaîne.

Développement d’applications

  • Une fois votre application développée, nous conseillons de la mettre à l’essai de façon rigoureuse pour vous assurer que l’expérience client est exempte d’erreurs.
  • Envisagez l’ouverture de l’URL d’installation dans une page de garde qui décrit les fonctionnalités de l’application avant de lancer un flux OAuth.
  • Votre URL de lancement pourrait envoyer les clients directement dans un flux OAuth pour établir l’identité/autorisation et lancer la configuration de l’application.

Soumission de votre application à l’App Directory

Dans le processus de soumission, nous vous conseillons fortement de fournir une URL vers une vidéo qui présente les fonctions de l’application. Cela réduira de façon significative le temps de révision de votre application.