Vous consultez actuellement l'aide de la version:
AEM Screens fournit une API RESTful simple conforme à la spécification Siren. Elle vous permet de parcourir la structure de contenu et d’envoyer des commandes aux périphériques au sein de l’environnement.
L’API est accessible à l’adresse suivante : http://localhost:4502/api/screens.json.
Le code JSON renvoyé par les appels d’API répertorie les entités associées à la ressource en cours. En suivant le lien vers lui-même (self-link) répertorié, chacune de ces entités est de nouveau accessible sous la forme d’une ressource REST.
Par exemple, pour accéder aux écrans de notre emplacement de démonstration, vous pouvez appeler :
GET /api/screens/content/screens/we-retail/locations/demo/flagship.json HTTP/1.1 Host: http://localhost:4502
curl -u admin:admin http://localhost:4502/api/screens/content/screens/we-retail/locations/demo/flagship.json
{ "class": [ "aem-io/screens/location" ], "links": [ { "rel": [ "self" ], "href": "http://localhost:4502/api/screens/content/screens/we-retail/locations/demo/flagship.json" }, { "rel": [ "parent" ], "href": "http://localhost:4502/api/screens/content/screens/we-retail/locations/demo.json" } ], "properties": {…}, "entities": [ { "class": [ "aem-io/screens/display" ], "links": [ { "rel": [ "self" ], "href": "http://localhost:4502/api/screens/content/screens/we-retail/locations/demo/flagship/single.json" } ], "rel": [ "child" ], "properties": { "title": "Single Screen Display", "height": 1440, "description": "Demo location of a single screen display.", "name": "single", "width": 2560, "idletimeout": 300, "layoutrows": 1, "layoutcols": 1 } }, … ] }
GET /api/screens/content/screens/we-retail/locations/demo/flagship/single.json HTTP/1.1 Host: http://localhost:4502
Le code JSON renvoyé par les appels d’API peut contenir la liste des actions disponibles sur la ressource.
L’écran, par exemple, répertorie une action broadcast-command qui permet d’envoyer une commande à tous les périphériques qui lui sont affectés.
GET /api/screens/content/screens/we-retail/locations/demo/flagship/single.json HTTP/1.1 Host: http://localhost:4502
curl -u admin:admin http://localhost:4502/api/screens/content/screens/we-retail/locations/demo/flagship/single.json
{ "class": [ "aem-io/screens/display" ], "links": […], "properties": {…}, "entities": […], "actions": [ { "title": "", "name": "broadcast-command", "method": "POST", "href": "/api/screens/content/screens/we-retail/locations/demo/flagship/single", "fields": [ { "name": ":operation", "value": "broadcast-command", "type": "hidden" }, { "name": "msg", "type": "text" } ] } ] }
POST /api/screens/content/screens/we-retail/locations/demo/flagship/single.json HTTP/1.1 Host: http://localhost:4502 :operation=broadcast-command&msg=reboot
curl -u admin:admin -X POST -d ':operation=broadcast-command&msg=reboot' http://localhost:4502/api/screens/content/screens/we-retail/locations/demo/flagship/single.json