Ressources d'installation de RAD Server

De RAD Studio
Aller à : navigation, rechercher

Remonter à API administrative de RAD Server


La base de données EMS stocke les données relatives aux périphériques recensés d'une application Notifications push EMS. Vous pouvez accéder à ces informations en utilisant la ressource Installations recensée.

Vous pouvez envoyer des notifications push EMS aux installations EMS (périphériques recensés) en utilisant l'application EMS Management Console.

Remarque : Utilisez les composants TEMSClientAPI et TCustomPushEvents pour recenser un nouveau périphérique (Installation EMS) et obtenir des données depuis la ressource Installations EMS.

Points de terminaison de ressource Installations

La ressource Installations expose les points de terminaison de ressource EMS suivants :

Méthode du point de terminaison Suffixe de ressource Type de requête HTTP Utilisez

GetInstallations

--

HTTP GET

Pour récupérer toutes les données d'une ressource Installations.

GetChannels

canaux

HTTP GET

Pour récupérer les canaux disponibles auxquels le périphérique est abonné.

GetInstallationFields

champs

HTTP GET

Pour récupérer les noms de champs de toutes les installations EMS.

GetInstallation

{id}

HTTP GET

Pour récupérer toutes les données d'une installation spécifique (périphérique recensé).
id est l'identificateur d'installation EMS unique dans la base de données EMS.

AddInstallation

--

HTTP POST

Pour ajouter une nouvelle installation EMS à la base de données EMS.

UpdateInstallation

{id}

HTTP PUT

Pour mettre à jour les champs d'installation EMS dans la base de données EMS.
id est l'identificateur d'installation EMS unique dans la base de données EMS.

DeleteInstallation

{id}

HTTP DELETE

Pour supprimer une installation de la base de données EMS.
id est l'identificateur d'installation EMS unique dans la base de données EMS.

Point de terminaison GetInstallations

Renvoie la liste des données d'installation EMS.

Utilisez la méthode QueryInstallations pour récupérer la liste des installations EMS.

En cas de réussite, la réponse du serveur EMS fournit la liste de toutes les installations EMS, avec des détails sur chaque installation.

  • _id
  • deviceToken
  • deviceType
  • _meta (champs creator, created et updated)
  • canaux
  • Champs personnalisés (facultatif)

Exemple de réponse

Voici un exemple de réponse : 

[  
   {  
      "_id":"384234D0-7CEC-4C29-8363-2CED46ACAD39",
      "deviceToken":"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W_NThA1HOZeZY9AmMkziY-Ri-REh1m-Qa8Dw2paBDTwXXZNrY1qa8nAFQGjXYaiS_5hiJ3cZDL7OB1zkcya4JoJCpUccmvm49yXHmcqBKC32rk23PKib8ZYyBmX_wgZhwM_vBozhKJ821wXDI",
      "deviceType":"android",
      "_meta":{  
         "creator":"00000000-0000-0000-0000-000000000000",
         "created":"2015-02-06T10:05:01.000Z",
         "updated":"2015-02-06T10:06:34.000Z"
      },
      "description":"Nexus 7 device.",
      "channels":[  
         "News"
      ]
   },
   {  
      "_id":"92690E39-889C-4CC1-9B54-404ABB0604A3",
      "deviceToken":"APA91bG5a4a4HMACivEP2hH-x_7PUIW8GT4lvdHQWGfnh0KB7lRTwDMyS-2cHqw4gJGj_kSTXHt6DRiuA5Zr_26d1la83nlUfBuPUPXfq_8IAuQBH7thf22_X9RWCJbbcj27OEkUx0u5ylno-RTOFR1rTicxkBai6sYqPLzmvJeySwyDdyQnk9o",
      "deviceType":"android",
      "_meta":{  
         "creator":"00000000-0000-0000-0000-000000000000",
         "created":"2015-02-06T10:55:03.000Z"
      },
      "channels":[  

      ]
   }
]

Point de terminaison GetChannels

Renvoie la liste des canaux disponibles auxquels le périphérique est abonné.

Utilisez la méthode RetrieveInstallationsChannelNames pour récupérer la liste des canaux disponibles.

En cas de réussite, la réponse du serveur EMS fournit la liste de tous les canaux disponibles.

Exemple de réponse

Voici un exemple de réponse : 

[  
   "News",
   "Weather"
]

Point de terminaison GetFields

Récupère les noms de champs de toutes les installations EMS depuis la base de données EMS.

Utilisez la méthode RetrieveInstallationsFields pour récupérer les noms de champs de toutes les installations EMS.

En cas de réussite, la réponse du serveur EMS fournit tous les noms de champs de l'installation EMS.

  • _id
  • deviceToken
  • deviceType
  • _meta (champs creator, created et updated)
  • canaux
  • Champs personnalisés (facultatif)

Exemple de réponse

Voici un exemple de réponse : 

[  
   {  
      "name":"_id"
   },
   {  
      "name":"deviceToken"
   },
   {  
      "name":"deviceType"
   },
   {  
      "name":"_meta",
      "fields":[  
         {  
            "name":"creator"
         },
         {  
            "name":"created"
         },
         {  
            "name":"updated"
         }
      ]
   },
   {  
      "name":"channels"
   },
   {  
      "name":"description",
      "custom":true
   }
]

Point de terminaison GetInstallation

Récupère toutes les données d'une installation EMS donnée (identifiée par id).

Votre requête doit fournir au moins le champ suivant :

  • _id

Utilisez la méthode RetrieveInstallations pour récupérer les champs d'une installation EMS.

En cas de réussite, la réponse du serveur EMS fournit tous les noms de champs de l'installation EMS.

  • _id
  • deviceToken
  • deviceType
  • _meta (champs creator, created et updated)
  • canaux
  • Champs personnalisés (facultatif)

Exemple de réponse

Voici un exemple de réponse pour l'installation EMS ayant pour id "384234D0-7CEC-4C29-8363-2CED46ACAD39" 

{  
   "_id":"384234D0-7CEC-4C29-8363-2CED46ACAD39",
   "deviceToken":"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W_NThA1HOZeZY9AmMkziY-Ri-REh1m-Qa8Dw2paBDTwXXZNrY1qa8nAFQGjXYaiS_5hiJ3cZDL7OB1zkcya4JoJCpUccmvm49yXHmcqBKC32rk23PKib8ZYyBmX_wgZhwM_vBozhKJ821wXDI",
   "deviceType":"android",
   "_meta":{  
      "creator":"00000000-0000-0000-0000-000000000000",
      "created":"2015-02-06T10:05:01.000Z",
      "updated":"2015-02-06T11:58:57.000Z"
   },
   "description":"Nexus 7 device",
   "channels":[  
      "News",
      "Weather"
   ]
}

Point de terminaison AddInstallation

Ajoute une nouvelle installation (périphérique recensé) à la base de données EMS.

Utilisez la méthode RegisterDevice pour recenser une nouvelle installation EMS.

Point de terminaison UpdateInstallation

Met à jour les données d'une installation EMS existante qui est stockée dans la base de données EMS.

Votre requête doit fournir au moins le champ suivant :

  • _id

Utilisez la méthode UpdateInstallation pour mettre à jour les données d'une installation EMS existante.

Point de terminaison DeleteInstallation

Supprime une installation EMS existante de la base de données EMS.

Votre requête doit fournir le champ suivant :

  • _id

Utilisez la méthode DeleteInstallation pour supprimer une installation EMS existante.

Champs des installations EMS

La ressource Installations de la requête EMS et les réponses peuvent inclure toute combinaison des champs suivants :

Elément Exemple Description 
"_id"

"384234D0-7CEC-4C29-8363-2CED46ACAD39"

Identificateur d'installation EMS unique dans la base de données EMS. 

"deviceToken"

"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W[...]vBozhKJ821wXDI"

Identificateur d'installation EMS unique dans la base de données EMS. 

"deviceType"

"android"

Type du périphérique (ios, android, winrt, winphone, dotnet). 

"_meta"

{
    "creator":"00000000-0000-0000-0000-000000000000",
    "created":"2015-02-06T10:05:01.000Z",
    "updated":"2015-02-06T10:06:34.000Z"
}
  • creator : Créateur d'installation EMS dans la base de données EMS.
  • created : Heure de création de l'installation EMS.
  • updated : Heure de mise à jour de l'installation EMS.
"channels"

[
    "News",
    "Weather"
]

Liste des canaux disponibles auxquels le périphérique est abonné.

Champs personnalisés 

"myCustomField": "My Custom Field description"

Informations supplémentaires stockées pour l'installation EMS.

Voir aussi

Récupérée de « http://docwiki.embarcadero.com/RADStudio/Alexandria/f/index.php?title=Ressources_d%27installation_de_RAD_Server&oldid=212812 »