APIs REST rest-apis
O AEM Screens fornece uma API RESTful simples que segue a especificação Siren. Ele permite navegar pela estrutura do conteúdo e enviar comandos para dispositivos no ambiente.
A API está acessível em http://localhost:4502/api/screens.json.
Navegar pela estrutura do conteúdo navigating-content-structure
O JSON retornado pelas chamadas de API lista as entidades relacionadas ao recurso atual. Após o link próprio listado, cada uma dessas entidades é novamente acessível como um recurso REST.
Por exemplo, para acessar as exibições em nosso local principal de demonstração, você pode chamar:
GET /api/screens/content/screens/we-retail/locations/demo/flagship.json HTTP/1.1
Host: http://localhost:4502
Ou usando curl:
curl -u admin:admin http://localhost:4502/api/screens/content/screens/we-retail/locations/demo/flagship.json
O resultado seria semelhante a:
{
"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
}
},
…
]
}
E, para acessar a Exibição de tela única, você pode chamar:
GET /api/screens/content/screens/we-retail/locations/demo/flagship/single.json HTTP/1.1
Host: http://localhost:4502
Execução de ações no recurso executing-actions-on-the-resource
O JSON retornado pelas chamadas de API pode conter uma lista de ações que estão disponíveis no recurso.
A exibição, por exemplo, lista uma ação broadcast-command que permite enviar um comando para todos os dispositivos atribuídos a essa exibição.
GET /api/screens/content/screens/we-retail/locations/demo/flagship/single.json HTTP/1.1
Host: http://localhost:4502
Ou usando curl:
curl -u admin:admin http://localhost:4502/api/screens/content/screens/we-retail/locations/demo/flagship/single.json
Resultado:
{
"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"
}
]
}
]
}
Para acionar essa ação, é necessário chamar:
POST /api/screens/content/screens/we-retail/locations/demo/flagship/single.json HTTP/1.1
Host: http://localhost:4502
:operation=broadcast-command&msg=reboot
Ou usando curl:
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