IoT Platform:API de données produit

Prérequis

Vous avez créé un produit et un appareil. Pour plus d'informations, consultez Créer un produit et Créer un appareil.

Créer une API de données produit

1. Dans la console IoT Platform, accédez à la page Overview et cliquez sur l'ID ou l'alias de l'instance Enterprise Edition cible.

2. Dans le volet de navigation de gauche, sélectionnez Data Service > Data API.

3. Cliquez sur l'onglet Product Data API, puis cliquez sur Create API.

4. Dans le panneau Create API, cochez la case correspondant au produit cible.

5. Cliquez sur Apply.

   L'API de données snapshot et l'API de données brutes du produit sont ajoutées à la liste des API de données produit.

   Paramètre	API de données snapshot	API de données brutes	API de données d'événement
   Nom de l'API	${productName} product snapshot data query	${productName} product raw data query	${productName} product event data query
   Chemin de l'API	/${productKey}/snapshot/data/get	/${productKey}/rawdata/get	/${productKey}/event/data/get

   ${productName} correspond au nom du produit et ${productKey} à l'identifiant unique du produit.

Modifier une API de données produit

Pour les API d'interrogation de données snapshot et brutes, vous pouvez modifier le nom de l'API, les paramètres de requête et les paramètres de réponse.

1. Sur la page Data API, cliquez sur l'onglet Product Data API.

2. Dans la liste des API, repérez l'API d'interrogation de données snapshot ou brutes du produit cible, puis cliquez sur Edit dans la colonne Actions.

3. Dans l'assistant Edit API, modifiez les API Basic Information, puis cliquez sur Next.

   Paramètre	Description
   Nom de l'API	Modifiez le nom de l'API. Le nom peut contenir des caractères chinois, des lettres, des chiffres, des traits de soulignement (_) et des tirets (-). La longueur maximale est de 30 caractères.
   Chemin de l'API	Ce paramètre ne peut pas être modifié.
   Tags d'API	Saisissez le contenu du tag et appuyez sur Entrée pour le créer. Les tags peuvent contenir des caractères chinois, des lettres, des chiffres, des traits de soulignement (_) et des tirets (-). Chaque tag peut comporter jusqu'à 30 caractères. Utilisez les tags pour ajouter des identifiants personnalisés à vos API afin d'en faciliter la gestion. Important Vous pouvez ajouter un maximum de cinq tags à une API.
   Description de l'API	Saisissez une description de l'API pour expliquer ses fonctionnalités et autres informations.
   Type de retour	Le format des données renvoyées après l'appel de l'API. Ce paramètre est fixé sur JSON.

4. Sur la page Configure Parameters and Test, modifiez les paramètres de configuration et les paramètres avancés.

   Catégorie	Élément de configuration	Description
   Paramètres de configuration	Paramètres de requête	Cliquez sur Add Parameter et sélectionnez un Bound Field. Pour le paramètre ajouté, définissez l'opérateur, indiquez s'il est obligatoire, et fournissez une valeur d'exemple ainsi qu'une description. Pour supprimer un paramètre, cliquez sur l'icône de suppression . Important Si le type de paramètre est numérique, l'opérateur LIKE n'est pas pris en charge.
   	Paramètres de réponse	Par défaut, tous les champs que l'API peut renvoyer sont sélectionnés. Vous pouvez indiquer si un champ sert au tri et fournir une valeur d'exemple ainsi qu'une description. Pour supprimer un paramètre, cliquez sur l'icône de suppression . Après avoir supprimé un paramètre, cliquez sur Add Parameter pour ajouter à nouveau un champ lié en tant que paramètre de réponse. Vous pouvez également cocher la case Select All Parameters à droite pour resélectionner tous les champs en tant que paramètres de réponse. Remarque Used for Sorting indique que les données interrogées sont triées par les valeurs de ce champ dans l'ordre croissant ou décroissant avant que les résultats de la requête ne soient renvoyés.
   	Ordre de tri	Sélectionnez l'ordre de tri des paramètres. Ascending (par défaut) : Les paramètres sont triés par ordre croissant. Descending : Les paramètres sont triés par ordre décroissant.
   Paramètres avancés	Activer la pagination des résultats	Indiquez si vous souhaitez activer la pagination des résultats renvoyés. Disabled : Vous pouvez afficher un maximum de 100 résultats. Enabled : Vous pouvez afficher tous les résultats sous forme paginée. Si vous activez cette fonctionnalité, les paramètres communs suivants sont automatiquement ajoutés : pageNum : Le numéro de page. pageSize : Le nombre de résultats à afficher par page. La valeur maximale est 100.
   	Paramètres d'erreur de délai d'expiration	Si une requête d'appel d'API dépasse 8000 millisecondes, une erreur de délai d'expiration est renvoyée. Ce paramètre ne peut pas être modifié.

5. Une fois la configuration terminée, dans la section Test API, saisissez les valeurs de test pour les paramètres de requête et cliquez sur Start Test.

   Consultez les données d'exemple dans l'onglet Response Example ou affichez les détails de la requête dans l'onglet Request Details.

   Les paramètres de requête incluent pageNum (INTEGER), pageSize (INTEGER), timestamp (BIGINT, obligatoire) et device_name (VARCHAR). Les données au format JSON dans l'exemple de réponse contiennent des champs liés à l'état de l'alimentation et de l'éclairage des appareils IoT, tels que date_time, ActivePower, LightVolt, PowerRatio, DrainVoltage, PowerConsumption, LightAdjustLevel, timestamp, device_name, iot_id, LightCurrent et LightStatus.

6. Cliquez sur Publish.

   Important

   • Assurez-vous que l'API a réussi le test avant de la publier.

   • Si vous cliquez uniquement sur Save pour une API, son Status sur la page API Details reste Unpublished.

   • Une API doit être publiée avant de pouvoir être appelée pour interroger des données.

   Après la publication de l'API, un message de réussite s'affiche et les champs API Name et API Path sont affichés. Cliquez sur Copy pour copier le chemin. Des exemples d'appels pour les SDK Java, Node.js et Python sont fournis en bas de page. Cliquez sur View List pour revenir à la liste des API ou sur Create Again pour créer une autre API.

Étapes suivantes

• Appelez une API de données produit pour afficher les données brutes, snapshot et d'événements d'un appareil spécifique dans un produit.

  Pour des exemples d'appels, consultez :

  • Exemple d'appel avec le SDK Java

  • Exemple d'appel avec le SDK Node.js

• Consultez l'utilisation de l'API sur la page API Details. Pour plus d'informations, voir Afficher une API.