Référence
Les renseignements recueillis sur cette page sont essentiels au développement de votre application et à l’utilisation des guides présents sur ce site.

États de l’application

Toutes les applications Yext ont un état App Directory : Privé Soumis Publié.
  • Privé
    • L’état par défaut lorsqu’une application est créée. L’état de l’application est privé et cette dernière ne peut pas être vue sur l’App Directory.
    • Une application peut être développée en mode privé et les jetons d’accès peuvent être demandés par OAuth sans restriction.
    • Changements d’état possibles :
      • Le développeur de l’application la soumet à l’App Directory→ Soumis
  • Soumis
    • L’application a été soumise par le développeur d’application à l’App Directory de Yext.
    • Yext révise l’application et décide de la publier, communique avec le développeur pour le questionner au sujet de l’application ou il la rejette.
    • Changements d’état possibles :
      • Le développeur d’application retire sa soumission à l’App Directory→Privé
      • Yext approuve l’application→Publié
      • Yext rejette l’application→Privé
  • Publiée
    • L’application a été publiée par l’App Directory et Yext communiquera avec le développeur à propos du changement d’état. L’application sera visible sur l’App Directory et les clients pourront l’installer.
    • Si à tout moment Yext conclut que l’application est en violation des conditions de l’App Directory ou des politiques de l’App Directory ou qu’elle est défectueuse ou qu’elle cause des problèmes dans la plateforme Yext ou pour les clients de Yext, Yext retirera l’application. Yext communiquera avec le développeur de l’application pour résoudre tout problème identifié.
    • Changements d’état possibles :
      • Le développeur de l’application la retire de l’App Directory→ Privé
      • Yext retire l’application→Privé
retour au début

Configuration de l’application

Lors de la création d’une application à l’intérieur du module développeur, vous devez fournir les valeurs pour les champs suivants :
  • Nom de l’application
    • Le nom de votre application, tel qu’il apparaîtra dans l’App Directory.
    • Une adresse électronique que les clients peuvent utiliser pour envoyer des questions, des commentaires et des demandes de soutien.
  • Adresse électronique
    • Adresse électronique valide
    • Une adresse électronique pour le développeur d’application qui sera utilisée par Yext pour la soumission de l’application ou si l’équipe de Yext a des questions ou des préoccupations à propos de l’application.
    • Cette adresse électronique ne sera pas indiquée publiquement si votre application est soumise à l’App Directory.
  • Téléphone
    • Numéro de téléphone valide
    • Un numéro de téléphone pour le développeur d’application qui sera utilisé par Yext pour la soumission de l’application ou si l’équipe de Yext a des questions ou des préoccupations à propos de l’application.
    • Ce numéro de téléphone ne sera pas indiqué publiquement si votre application est soumise à l’App Directory.
  • Autorisations
    • Le niveau d’autorisation dont votre application a besoin, qui est soit « lecture seule » soit « consulter/rédiger ». Ce paramètre sera appliqué à tous les points de terminaison sélectionnés pour votre application.
  • Points de terminaison
    • La liste des points de terminaison auxquels votre application doit avoir accès.
    • Vous devez sélectionner au moins un point de terminaison.
Les champs facultatifs sont indiqués ci-dessous :
  • Comportement des champs personnalisés
    • Le comportement de champ personnalisé auquel votre application adhérera. De plus amples renseignements concernant ce paramètre se trouvent dans la section gestion des champs personnalisés.
    • Ne peut pas être « Enable for all fields » si l’application est soumise à l’App Directory.
  • Domaines de redirection OAuth
    • Liste des domaines valides
    • Une liste de domaines valides vers lesquels Yext redirigera un client lorsque celui-ci aura complété le processus OAuth. Le domaine de votre REDIRECT_URI doit être identique au domaine dans cette liste, y compris les sous-domaines.
  • Clés API
    • Une liste des clés API qui sont utilisées pour authentifier votre application lors d’échanges de jetons d’accès OAuth, en plus d’accéder à votre propre instance du gestionnaire de l’information.
    • Considérez ces clés comme les secrets de vos clients –ne les dévoilez pas sans une connexion sécurisée avec Yext lors d’appels API.
retour au début

Configuration de l’App Directory

Pour répertorier votre application dans l’App Directory de Yext, vous devez fournir les valeurs de tous les champs de l’ « App Directory » avant de commencer le processus de soumission. Ces champs sont :
  • Logo
    • Au moins 250 x 250 px
    • Un logo qui représente votre application. Cette image inclut généralement le logo de la plateforme avec laquelle votre application s’intègre.
  • Catégories
    • Pas plus de trois catégories
    • Jusqu’à trois catégories qui décrivent l’objet de votre application. La première catégorie que vous choisissez sera la catégorie principale, elle apparaîtra dans les listes de l’App Directory.
    • Catégories actuelles :
      • Publicité et marketing
      • Données analytiques et veille économique
      • Saisie de contenu
      • Gestion de la relation client
      • Fidélisation de la clientèle
      • Soutien à la clientèle
      • Adresse électronique
      • Gestion des établissements et ressources humaines
      • Soins de santé
      • Point de vente
      • Médias sociaux
      • Services de traduction
      • Sites Web
  • Court titre d’appel
    • Maximum 100 caractères
    • Une description courte qui apparaîtra à côté du nom de votre application dans les listes de l’App Directory. Ce texte doit décrire de manière concise l’objet de votre application.
    • Exemple : « Synchronisation des données d’établissement de Yext avec le système de gestion de la relation client de ExampleCo »
  • Description détaillée
    • Maximum 5 000 caractères
    • Une description détaillée qui apparaîtra sur votre page de détails dans l’App Directory.
    • Utilisez ce texte pour décrire l’objet de votre application, afficher votre texte publicitaire, indiquer les exigences d’utilisation de l’application et fournir des instructions d’installation de base.
  • URL de la vidéo Vimeo
    • URL valide pour une vidéo Vimeo
    • Une vidéo qui montre aux clients les fonctions de votre application. Cette vidéo sera intégrée à la page d’inscription de votre application.
    • Cette vidéo doit être informative et de haute qualité. Elle doit montrer aux clients l’installation de l’application, son fonctionnement et la valeur qu’elle leur apporte.
  • Application développée par
    • Maximum 50 caractères
    • Le nom du développeur tel qu’il doit être indiqué dans l’App Directory
  • Page d’accueil
    • URL valide
    • Page d’accueil de votre application. L’URL peut diriger vers une page précisément associée à votre application ou vers la page d’accueil de la plateforme externe.
  • Adresse électronique du soutien à la clientèle
    • Adresse électronique valide
    • Une adresse électronique que les clients peuvent utiliser pour envoyer des questions, des commentaires et des demandes de soutien.
  • Conditions d’utilisation
    • URL valide
    • Un lien vers les conditions d’utilisation de l’application.
  • Politique de confidentialité
    • URL valide
    • Un lien vers la politique de confidentialité de l’application.
  • URL d’installation de l’application
    • URL valide
    • L’URL qui lance votre application, si votre application n’est pas déjà liée à un client (« installée »).
    • Envisagez l’ouverture d’une page d’accueil facultative pour décrire les fonctions de l’application avant de lancer un flux OAuth.
    • L’URL d’installation de l’application et l’URL de lancement de l’application peuvent être la même, si vous le souhaitez.
  • URL de lancement de l’application
    • URL valide
    • L’URL qui lance votre application, si votre application est déjà liée à un client (« installée »).
    • Envisagez de mettre les clients directement dans un flux OAuth pour établir l’identité/autorisation et lancer la configuration de l’application.
    • L’URL d’installation de l’application et l’URL de lancement de l’application peuvent être la même, si vous le souhaitez.
  • Instructions d’essai
    • Recueillies lors du processus de soumission de l’application.
    • Des instructions pour l’équipe de révision de l’App Directory de Yext sur la façon de mettre à l’essai toutes les fonctions de l’application. Incluez les identifiants des comptes d’essai et les instructions détaillées sur la façon d’utiliser l’application.
    • Si nous ne pouvons pas mettre toute votre application à l’essai à l’aide de ces instructions, nous communiquerons avec vous, ce qui retardera l’approbation de l’App Directory.
  • URL de la vidéo
    • Recueillies lors du processus de soumission de l’application.
    • URL valide
    • Une vidéo facultative qui présente à l’équipe de révision de l’App Directory de Yext les fonctions de votre application.
    • Nous vous recommandons fortement de fournir une vidéo pour réduire de façon importante le temps de révision de votre application.
retour au début

Directives en matière d’image de marque de Yext

Si vous utilisez la marque de Yext dans votre application, veuillez respecter nos directives en matière d’image de marque, telles que décrites sur Brandfolder et utilisez les ressources qui y sont fournies.

retour au début

Mise en œuvre de l’application de référence

Nous avons conçu une application de référence, qui est hébergée sur GitHub. Cette application de référence est conçue pour vous aider à comprendre comment mettre au point une application selon nos pratiques exemplaires.

retour au début