Local Web API

Local Web API is a simple way for integrating outside devices and trigger content in the player through a local network HTTP call.

The Local Web API is supported by OnSign TV on Android, Windows, Linux, Mac, and BrightSign players.

Important: To use the Local Web API this option must be enabled in the player settings.

enable local web api in player settings

Local Web API for Android Player 9.8.5

Endpoint Method Meaning
http://127.0.0.1:5544/trigger/{pattern} POST Triggers the play of a campaign or a playlist which is configured with an interactivity containing the pattern {pattern}.
http://127.0.0.1:5544/campaign/current/stop POST Stops the current content playing, skipping to the next one in the loop.
http://127.0.0.1:5544/attribute/{name}/{value} PUT Sets the attribute {name} with the value {value}.
http://127.0.0.1:5544/attribute/{name} GET Retrieves the attribute named {name} as JSON, in the format {"name": "attr_name", "value": "attr_value"}. If no value is set for this attribute or attribute doesn't exist, returns {"name": "attr_name", "value": null}.
http://127.0.0.1:5544/attributes GET Retrieves list of all attributes currently set as JSON, in the format {"attributes": [{"name": "attr_name", "value": "attr_value"}]}. If no value is set for an attribute, it is not listed.

Local Web API for Windows/Mac/Linux Player 9.3.9:

Endpoint Method Meaning
http://127.0.0.1:5544/trigger/{pattern} GET, POST Triggers the play of a campaign or a playlist which is configured with an interactivity containing the pattern {pattern}.
http://127.0.0.1:5544/campaign/current/stop GET, POST Stops the current content playing, skipping to the next one in the loop.
http://127.0.0.1:5544/playback/status GET, POST Retrieve the playback status as JSON, in the format {"visible": true, "playing": true}.
http://127.0.0.1:5544/playback/show GET, POST Shows the player window. If window is already visible, nothing happens.
http://127.0.0.1:5544/playback/hide GET, POST Hides the player window. Playback still happens in the background.
http://127.0.0.1:5544/playback/start GET, POST Starts playing content. If content is already playing, nothing happens.
http://127.0.0.1:5544/playback/stop GET, POST Stops playing content. Displays a black screen until playback is resumed.