A API Web Local permite o control de reprodução de conteúdos do player através de uma simples chamada HTTP.
A API Web Local é suportado pelos players Android, Windows, Linux, Mac e BrightSign.
Importante: Para usar a API Web Local tem que habilitar essa função nas configurações do Player.
API Web Local para Player 9.8.5 de Android Player
| Endpoint | Método | Efeito |
|---|---|---|
| http://127.0.0.1:5544/trigger/{pattern} | POST | Aciona a reprodução de uma campanha ou playlist configurada interativa pelo padrão {pattern}. |
| http://127.0.0.1:5544/campaign/current/stop | POST | Interrompe a reprodução do conteúdo atual, pulando para o próximo no loop. |
| http://127.0.0.1:5544/attribute/{name}/{value} | PUT | Define o atributo {name} com o valor {value}. |
| http://127.0.0.1:5544/attribute/{name} | GET | Traz o atributo chamado {name}, como JSON, no formato {"name": "attr_name", "value": "attr_value"}. Se este atributo não tiver nenhum valor ou o atributo não existir, retorna {"name": "attr_name", "value": null}. |
| http://127.0.0.1:5544/attributes | GET | Traz a lista de todos os atributos atualmente definidos como JSON, de formato {"attributes": [{"name": "attr_name", "value": "attr_value"}]}. Se um atributo não tiver valor, não será incluído na lista. |
API Web Local para Player 9.3.9 de Windows/Mac/Linux Player:
| Endpoint | Método | Efeito |
|---|---|---|
| http://127.0.0.1:5544/trigger/{pattern} | GET, POST | Aciona a reprodução de uma campanha ou playlist configurada interativa pelo padrão {pattern}. |
| http://127.0.0.1:5544/campaign/current/stop | GET, POST | Interrompe a reprodução do conteúdo atual, pulando para o próximo no loop. |
| http://127.0.0.1:5544/playback/status | GET, POST | Traz o status da reprodução como JSON, no formato {"visible": true, "playing": true}. |
| http://127.0.0.1:5544/playback/show | GET, POST | Mostra a janela do player. Se a janela já estiver visível, nada mais acontece. |
| http://127.0.0.1:5544/playback/hide | GET, POST | Esconde a janela do player. A reprodução ainda acontece em segundo plano. |
| http://127.0.0.1:5544/playback/start | GET, POST | Inicia a reprodução do conteúdo. Se o conteúdo já estiver sendo reproduzido, nada mais acontece. |
| http://127.0.0.1:5544/playback/stop | GET, POST | Interrompe a reprodução do conteúdo. Exibe uma tela preta até que a reprodução seja retomada. |