Evolution Produit : Annonce du retrait de l’API Device Management LoRa V0

L’API Device Management for LoRa V0 est dépréciée depuis le 28/02/2018 et sera retirée le 31/07/2022
Cette API est remplacée par un ensemble d’APIs, selon le endpoint considéré, et ces APIs sont :

• DeviceManagement – Inventory V1
• Inventory Explorer V1
• DeviceManagement – Interfaces V1
• DeviceManagement – Commands V1
• DeviceManagement – Connector Nodes – LoRa SpecificV1

Pour chacun des endpoints à migrer il existe une solution à suivre, qui est résumée ci-dessous

Considérations préliminaires

Attention :
Pour certains endpoints, l’argument d’entrée a changé : il faut dorénavant utiliser {deviceId} au lieu de {devEui}.
Celui-ci se construit facilement à partir de {devEui} :
urn:lo:nsid:lora:{devEui}

Nous rappelons que le device LoRa utilisé précédemment est maintenant assimilé à l’interface LoRa. Cette Interface est rattachée au device, quelque soit le type de connexion impliqué (MQTT, SMS, LoRa)
Un device peut avoir plusieurs interfaces qui lui sont rattachées

Endpoint : GET /api/v0/vendors/lora/devices

• Nouvelle API : Device Management – Inventory – V1
• Nouveau endpoint :

 GET /api/v1/deviceMgt/devices?connectors=lora  

Pour plus d’information, veuillez consulter le manuel utilisateur 5.3.2 List Devices

Endpoint : POST /api/v0/vendors/lora/devices

• Nouvelle API : Device Management – Inventory – V1
• Nouveau endpoint :

 POST /api/v1/deviceMgt/devices  

Pour plus d’information, veuillez consulter le manuel utilisateur 5.3.1 Register a Device

Endpoint :
GET /api/v0/vendors/lora/devices/count

• Nouvelle API : Inventory Explorer – V1
• Nouveau endpoint :

  POST /api/v1/deviceMgt/explorer/stats  

Le corps de la requête donnant le nombre d’équipements LoRa activés et désactivés est écrit ci-dessous :

{
     "filters": {
         "queryString": "interfaces.connector == lora"
     },
     "groupBy": {
         "interfaces": {
             "field": "status"
         }
     }
 }

{
     "filters": {
         "queryString": "interfaces.connector == lora"
     },
     "groupBy": {
         "interfaces": {
             "field": "status"
         }
     }
 }

Exemple de réponse :

{    
     "devices": 26,
     "fieldAggregation": {
       "count": 26,
       "devices": 26,
       "buckets": [
         {
           "key": "ACTIVATED",
           "count": 12,
           "devices": 12
         },
         {
           "key": "REGISTERED",
           "count": 10,
           "devices": 10
         },
         {
           "key": "INITIALIZED",
           "count": 2,
           "devices": 2
         },
         {
           "key": "DEACTIVATED",
           "count": 1,
           "devices": 1
         },
         {
           "key": "REACTIVATED",
           "count": 1,
           "devices": 1
         }
       ]
 }

Veuillez noter que la nouvelle requête donne plus d’informations que la précédente version
Pour plus d’information, veuillez consulter le manuel utilisateur 9.3 Statistics API

Endpoint :
GET /api/v0/vendors/lora/devices/{devEUI}

• Nouvelle API : Device Management – Inventory – V1
• Nouveau endpoint :

  GET /api/v1/deviceMgt/devices/{deviceId}

Pour plus d’information, veuillez consulter le manuel utilisateur 5.3.3 Get a Device

Endpoint :
PATCH /api/v0/vendors/lora/devices/{devEUI}

Selon le type de mise à jour à effectuer sur l’équipement, vous devez utiliser soit 

A- Si l’une des caratéristiques suivantes doit être modifiée : id, name, description, defaultDataStreamId, tags, properties, group, staticLocation

• Nouvelle API : Device Management – Inventory – V1
• Nouveau endpoint :

 PATCH /api/v1/deviceMgt/devices/{deviceId} 

B- Si une autre caractéristique non mentionnée en A- doit être modifiée

• Nouvelle API : Device Management – Interfaces – V1
• Nouveau endpoint :

 PATCH /api/v1/deviceMgt/devices/{deviceId}/interfaces/lora:{devEUI}

Pour plus d’information, veuillez consulter le manuel utilisateur 14.3.2 Static location ou bien user manuel 5.4.4 Update an Interface

Endpoint :
DELETE api/v0/vendors/lora/devices/{devEUI}

• Nouvelle API : Device Management – Inventory – V1
• Nouveau endpoint :

 DELETE /api/v1/deviceMgt/devices/{deviceId} 

Pour plus d’information, veuillez consulter le manuel utilisateur 5.3.4 Delete Device

Endpoint :
GET /api/v0/vendors/lora/devices/{devEUI}/commands

• Nouvelle API : Device Management – Commands – V1
• Nouveau endpoint :

 GET /api/v1/deviceMgt/devices/{deviceId}/commands 

Pour plus d’information, veuillez consulter le manuel utilisateur 8.3 Commands pour les principes généraux, et plus spécifiquement les chapitres 8.3.10.2 sur LoRa commands registration et 8.3.11.2 montrant quelques exemples

Endpoint :
POST /api/v0/vendors/lora/devices/{devEUI}/commands

• Nouvelle API : Device Management – Commands – V1
• Nouveau endpoint :

 POST /api/v1/deviceMgt/devices/{deviceId}/commands 

Pour plus d’information, veuillez consulter le manuel utilisateur 8.3 Commands pour les principes généraux, et plus spécifiquement les chapitres 8.3.10.2 sur LoRa commands registration et 8.3.11.2 montrant quelques exemples

Endpoint : GET /api/v0/vendors/lora/profiles

• Nouvelle API : Device Management – Connector Nodes – LoRa Specific – V1
• Nouveau endpoint :

 GET /api/v1/deviceMgt/connectors/lora/profiles 

Un simple changement de path

Rappel ci-dessous des points d’accès principaux à la documentation

Swagger: https://liveobjects.orange-business.com/#/cms/documentation-swagger/

Guide du Développeur : https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html