Overview

The Signagelive Player API is a RESTful web service which will allow you to develop your own players to connect to Signagelive. All requests to authenticate and operate against the Signagelive API will be performed using SSL over HTTP (HTTPS) on TCP port 443.

The API will support data in both JSON and XML formats to enable maximum client support. The default format is JSON. All request and response examples are in JSON format. To request a response using XML clients must use the Accept header in requests with a value of application/xml

Requests and Responses Information on all possible API requests can be found under ‘API Reference’.

See response codes for a list and description of the possible HTTP response codes that can be returned by the API.

Current Status

The Web Triggers API is currently in alpha testing and is only available to select Signagelive partners.

Release Notes

Setup Onboarding - Web Triggers

On receipt of a request for access to the Web Triggers API Signagelive will perform the initial onboarding and setup to make the Web Triggers available on a per network basis. Note that a single application can be made available to multiple networks.

Once setup is complete users will be provided with a network Id, application Id and application key, which should be used to authenticate requests made against the Web Triggers API. More details on this are provided in the next section on API Authorization.

A newly configured Web Triggers environment will by default contain:

• All active players on the network
• An all group, which contains all players on the network (see here for more information)
• Triggers for all available triggers keys in Signagelive

End points - Media Player

Several endpoints are used by the Signagelive platform. We have supplied a list below for reference when connecting to the API, and for help configuring firewalls.

Postman - Web Triggers

Signagelive have made available a Postman configuration with a sample collection of all available requests to help partners get started using the API.

The postman configuration file can be downloaded here

For more information about Postman and to download Postman for Chrome see here

Authorization

As part of the onboarding process API users will be provided with an Application ID and Application Key by Signagelive.

This Application ID and Application Key must be sent with each request using the following headers:

• X-SIGNAGELIVE-WBI-APP-ID: {application_id}
• X-SIGNAGELIVE-WBI-APP-KEY:{application_key}

The provided application Id and application key will only authorize requests made against the user’s specified network.

Requests made against the API that do not include these headers will return a 400 Bad Request response status.

Requests made against the API that include invalid credentials will return a 401 Unauthorized response status.

Requests made against the API that include valid credentials that have been disabled by Signagelive will return a 403 Forbidden response status.

Note that Signagelive intends to replace this authentication mechanism with OAuth authentication in the future.

Response Codes

The Signagelive Player API will return standard HTTP response codes, clients are expected to respect the response from the API, particularly relating to bad requests, rate limits etc and not attempt to make the call again until either the issue has been resolved or timeout period has passed.

Concepts

To use the API effectively, you should understand several key concepts:

Players

Players are active Signagelive media players available on your Signagelive network.

Groups

Groups are used to organise players. Content can be triggered for groups as well as individual players. Organising your players into groups can simplify triggering content on predefined subsets of your Signagelive network.

Player Groups

Each network has a default all group, which is created when the network is configured to be able to use the Web Triggers API. All players are added to the all group by default and users can not:

• Edit or delete the All group
• Add or remove players from the all group

Triggers

Triggers map to interrupts published to your Signagelive players based on the payload property.

As an example, a player with a Fire Alarm interrupt published to it with the trigger key F would map to a trigger with the payload defined as F.

Messages

Content is triggered on your players by sending a message containing the trigger (interrupt) to play and the list of players and/or player groups to trigger the content on.

Models

Below you can find all the data relating to the above mentioned concepts.

Players

Field Definitions

Example

{
"id": 1
"serialNumber": "30001",
"description": "Sample Player 1",
"enabled": true,
"lastModified": "2016-05-19T13:51:39",
"groups": [],
}

Groups

Field Definitions

Example

{
"id": 1
"name": "All",
"description": "A default group for all of the players",
"isAllGroup": true,
"players": [],
}

Player Groups

Field Definitions

Example

{
"id":5
"player":1,
"group":2,
}

Triggers

Field Definitions

Example

{
"id": 2
"name": "Goal Scored",
"description": "Goal Scored content matched to Interrupt Key G",
"payload": "G",
"previewurl": null,
}

Messages

Field Definitions

Example

{
"id":10
"interrupt":1,
"players":[1,2],
"groups":[2],
}

Reference

Below you will find the API reference data for the above-mentioned models and concepts.

Players

Get All Players

Get Player

Groups

Get All Groups

Get Group

Create Group

{ 
"name": "New Group", 
"description": "Description of my new group",
"isAllGroup": false, 
"players": [], "id": 3 
}

Update Group

{ 
"name":"My New Group", 
"description":"Description of My New Group", 
"players":[], 
"isAllGroup":false, 
"id": 3 
}

Delete Group

Player Groups

Add Player to Group

Remove Player from Group

Triggers

Get All Triggers

Get Trigger

Create Trigger

Update Trigger

Delete Triggers

Messages

Send Message