Premiers pas avec le développement
SOMMAIRE :
- Par où commencer ?
- Créer votre compte développeur Microshare
- Travailler avec l’API
- Premiers pas avec la plateforme Microshare
- Comment créer une application
- Prêt pour la suite
1. Par où commencer ?
La quantité d’informations dédiées au développeur peut sembler écrasante ; ce guide vous aide à naviguer pour bien démarrer et décrit le parcours à suivre pour mieux comprendre Microshare. Après avoir lu la Vue d’ensemble du rôle du développeur et compris la Structure technique de Microshare, vous devriez commencer par créer votre compte développeur Microshare, qui vous donnera la possibilité de créer des robots, des règles, des vues, des applications et des clusters d’appareils.
2. Créer votre compte développeur Microshare
Suivez les étapes décrites sur la page Créer un compte, mais assurez-vous d’utiliser l’environnement http://dapp.microshare.io. Dans l’environnement développeur, vous pourrez tester la création de clusters d’appareils, de tableaux de bord, l’édition de vues, la création de règles et de robots.
3. Se familiariser avec l’API Microshare
Authentification
Commencez par consulter le Démarrage rapide API pour installer l’application Postman et apprendre la terminologie de l’API Microshare. Ensuite, utilisez le Guide d’authentification où vous apprendrez à naviguer dans les fonctionnalités de sécurité de l’API Microshare en demandant votre propre jeton. Il est crucial de terminer le guide d’authentification avant de passer au tutoriel de requêtes simples, car vous ne pourrez pas effectuer les requêtes sans authentification.
Share API
En suivant le tutoriel Share API, vous apprendrez à envoyer et demander des informations à l’API Microshare. Ces concepts sont les composants fondamentaux pour travailler avec les robots et les clusters d’appareils par la suite.
4. Premiers pas avec la plateforme Microshare
Une fois configuré dans l’environnement développeur, suivez les étapes suivantes pour interagir avec l’environnement Microshare :
Clusters d’appareils
Les Clusters d’appareils vous permettent de regrouper vos appareils situés dans des emplacements similaires, en combinant les données des appareils individuels. À partir de là, vous pouvez créer des applications pour afficher et analyser les informations du cluster, et utiliser des règles pour contrôler la façon dont les autres peuvent consulter ces informations.
Vues
Une Vue est un composant pour gérer l’accès à vos données. Elle vous permet d’envoyer des données statiques, d’interroger le lac de données, de gérer le contenu et d’appliquer des contrôles sur les éléments de données ainsi que les règles de partage.
Tableau de bord
Les Tableaux de bord vous permettent d’organiser les applications ensemble et d’éliminer l’encombrement sur votre page de gestion. Cela sera particulièrement utile pour regrouper les applications d’un client. Il est important de noter qu’une grande partie du contenu du guide des tableaux de bord relève de la catégorie développeur avancé.
Règles
Une Règle est une expression concrète d’une politique de partage. Elle permet à un propriétaire de données de définir les conditions dans lesquelles une opération demandée sera accordée. Les règles autorisent uniquement le partage. Les règles n’empêchent pas le partage. Le partage est bloqué par défaut.
5. Comment créer une application
Tout d’abord, rendez-vous sur dapp.microshare.io et connectez-vous. Ensuite, accédez à l’onglet applications marqué en vert et cliquez sur l’icône clé pour créer une nouvelle application. À partir de là, vous devriez voir :
Configurez votre application avec les options suivantes :
App Type: Display
Parent Tag(s): Laisser vide
Style Choice: Showcase
Theme: https://s3.amazonaws.com/cdn.point.io/distribution/product/1_00/stylesheet.common.css
Include: Laisser vide sauf demande contraire
Facts to display: None
Form to display: Pour les applications en temps réel, choisir Realtime Form v2.5 et Trending Form v2.6 pour les applications de tendance
Maintenant, configurez votre application avec des facts. Créez un nouveau fact en appuyant sur le bouton au-dessus de la flèche verte et en cliquant sur apend.
Voici quelques détails sur les facts requis par toutes les applications. Pour des facts plus spécifiques par type d’appareil, consultez le Guide des tableaux de bord.
appTitle: Doit correspondre au nom que vous avez fourni comme nom de l’application (ci-dessus).
navOptions: Ces identifiants doivent être complétés en dernier. Ajoutez les liens et noms de toutes les applications du compte du client à chaque app.json afin que le client puisse naviguer d’une application à l’autre.
selectionOptions: Toutes les applications vous demandent de fournir les options d’emplacement spécifiques au client dans le champ navOptions. Utilisez le databoard pour générer le JSON au bon format. Obtenez un jeton pour le compte qui possède le(s) cluster(s) d’appareils et rendez-vous sur https://databoard.azurewebsites.net/dashboard/0. Choisissez Edit Workspace dans le menu des paramètres, puis Add Monitor Widget pour les clusters concernés, puis Lock Workspace, puis cliquez sur le moniteur d’appareils pour afficher la vue liste, puis cliquez sur Download JSON.
dataRecType: correspond au recType cible du cluster d’appareils.
dataContext: Utilisez la balise meta que vous avez choisie dans le cluster d’appareils.
queryId, queryId1, queryId2, queryId3: il est recommandé de laisser les paramètres de requête identiques à ceux du json d’exemple
footerLogo, headerLogo, header SecondaryLogo et get RecType: ne pas modifier sauf demande contraire.
Après avoir complété tous les facts nécessaires ci-dessus et ceux du Guide des tableaux de bord, vous pouvez terminer en cliquant sur le bouton create indiqué par la flèche verte ci-dessous.
6. Prêt pour la suite ?
Rendez-vous sur la Feuille de route développeur avancée pour approfondir l’interaction avec la plateforme Microshare.
Vous avez des questions ? N’hésitez pas à contacter support@microshare.io pour toute assistance.
Cette documentation vous a-t-elle été utile ?
Pour toute question ou assistance supplémentaire, contactez-nous à support@microshare.io
