Cet article explique comment enregistrer une application et la publier sur le marché des applications de la plateforme. L'article suppose que vous développez une application capable d'interagir avec l'API ouverte de la plateforme.
Contenu
Introduction
La plateforme EM dispose d'un marché d'applications qui permet à l'utilisateur d'installer des applications pour étendre les fonctionnalités de la plateforme en utilisant l'API ouverte de la plateforme. Vous pouvez trouver plus d'informations sur l'API ici.
Prérequis
Vous aurez besoin d'un utilisateur superAdmin pour enregistrer une application pour votre compte. Vous aurez besoin des URL de votre application pour l'installation, la désinstallation et toutes les vues et/ou rapports que l'application générera.
Comment ça marche ?
Accédez au menu "Gestion du compte" en cliquant sur le bouton avec votre initiale en haut à droite de l'écran de la plateforme.
Une fois dans le menu Gestion du compte, cliquez sur "Applications du marché" :
Cliquez sur le bouton "Nouvelle application de marché" pour enregistrer une nouvelle application. Le formulaire d'enregistrement de l'application apparaîtra avec les zones suivantes :
- Informations générales
- Tarification (non utilisée)
- URL
- Rapports Autorisations
Informations générales
Vous pouvez saisir les informations générales de l'application, telles que :
- Nom : le nom de l'application
- Description : une brève description. Elle permet une mise en forme HTML simple, des images et des GIF.
- Image : l'icône de l'application qui apparaîtra lorsqu'elle sera répertoriée sur le marché des applications
- Contact : informations de contact (telles qu'une adresse e-mail)
- Logiciel par : qui a développé l'application
- Visibilité : choisissez la visibilité de l'application dans la plateforme :
- Privé : l'application ne sera disponible que pour votre organisation et vos clients.
- Public : l'application sera disponible pour n'importe quel utilisateur de la plateforme (en dehors de votre organisation et de vos clients)
URLs
Il s'agit des principales URL que la plateforme utilisera lorsqu'elle devra interagir avec l'application, lors de la configuration ou lorsque l'utilisateur accède à l'application. Elles doivent pointer vers les points d'extrémité de l'application. Pour cet exemple, nous supposerons que l'application est hébergée sur le domaine app.domain.com.
Les éléments suivants doivent être renseignés :
- Conditions d'utilisation : facultatif. Vous pouvez répertorier un site avec les conditions d'utilisation qui doivent être examinées et acceptées par l'utilisateur avant d'utiliser l'application.
- Installation : requis. Cet point d'extrémité sera interrogé lorsque l'application est installée par un utilisateur dans un compte. Vos développeurs peuvent en savoir plus sur le processus d'installation de l'application ici.
- URL de nettoyage : facultatif. Cette extrémité sera interrogée lorsque l'application est désinstallée.
- Vues : facultatif. Les vues de l'application qui seront accessibles depuis l'interface de la plateforme et l'emplacement dans l'interface où elles seront disponibles. Selon le type d'application développée, vous voudrez indiquer différentes écrans. Il aura besoin des éléments suivants pour chaque écran :
- Nom de la vue Point d'extrémité
- URL que la plateforme interrogera
- L'écran où il sera affiché.
Si votre application ne crée que des rapports, les vues peuvent être laissées vides. Vous pouvez ajouter plusieurs vues pour une application donnée.
Des exemples pourraient être les suivants :
Rapports
Si votre application crée des rapports, ils devront être informés dans cette section. Le rapport de l'application sera accessible dans la section Rapports de la plateforme et sera sélectionnable lors de la création d'un nouveau rapport.
Vous devrez informer les éléments suivants lors de l'enregistrement de l'application :
- Nom : le nom du modèle de rapport
- Image : une image pour le rapport (facultatif) URL : 3
- URL différentes doivent être spécifiées ici :
- Formulaire de création de rapport
- Formulaire d'édition de rapport
- URL de l'application
Vous pouvez ajouter plusieurs rapports pour une application donnée.
Autorisations
Déterminez quelles parties de votre compte seront accessibles pour l'application en tant qu'accès en lecture et/ou en écriture. Si l'application a besoin d'accéder aux lectures mais que l'autorisation n'a pas été définie, l'application ne pourra pas accéder aux lectures.
Une fois que vous avez tout configuré, appuyez sur le bouton Enregistrer et votre application apparaîtra dans la liste des applications sur la section Applications du marché dans la Gestion du compte au cas où vous auriez besoin de la modifier :
Les hachages de l'identifiant d'application et du secret d'application (grisés sur l'image) seront nécessaires et devront être enregistrés dans votre application, car ils seront nécessaires chaque fois que l'application sera installée dans l'un de vos comptes. Vos développeurs peuvent en savoir plus sur le processus d'installation de l'application et sur la manière dont ces hachages sont utilisés ici.
Vous pourrez désormais tester votre application, car elle sera disponible sur le marché pour vos comptes. Lorsque vous serez prêt à partager l'application avec vos utilisateurs, vous pourrez publier l'application.
Publication de l'application
Dans la liste des applications du marché, cliquez sur "Sélectionner une action" et appuyez sur "Publier" pour publier votre application. Votre demande de publication devra ensuite être validée par l'équipe de support de la plateforme EM. Son statut restera en attente jusqu'à ce que votre demande soit traitée.