Notification Service API

Overview

NoviSign allows customers to send to their media players remote events, in order to present dynamic content, alerts, etc., by using push notifications services.

Use case

A salesperson has made a sale and the company wants to celebrate and display it over dedicated screens in the office floor where that specific salesperson works.

Please note. In order to use the Notification service API client should authenticate and fetch the Bearer token used for all API calls. Feel free to contact our support team to initiate this process and get access to the Notification service API.

API Authentication

For the notifications API before making API calls, client should first authenticate and fetch the Bearer token used for all API calls:

POST https://auth.novisign.com/keycloak/auth/realms/{your_account}/protocol/openid-connect/token

Headers:

Content-Type: application/x-www-form-urlencoded

Body

grant_type=client_credentials&client_id={{client_id}}&client_secret={{client_secret}}

Sending Data

For sending the dynamic data, the following API call should be used:

POST https://notifications.novisign.com/api/notification

Body – should be JSON without arrays (simple key value Nodes):


{
  "to":  "playerEvents/{{PLAYER_CHANNEL_ID}}”,
  "name": "{{EVENT_NAME}}",
  "data": 
      {
        "name": "{{EVENT_NAME}}",
        "category": "playlistTrigger",
        "data": {
        "creativeParams": 
                    {
                        "param_key": “param_value” 
                    }
      }
}

“to” – The specific channel that the player/s are registered to. (See player configuration below)

“name” – The event name which will be sent and triggered by the player. Should be set on studio.

“data” – The data needs to be injected and used within the triggered creative.

Example:

“to” : “CHANNEL1”,

“name” : “RFID:1”,

“data” : JSON with data

Studio Configuration

In order to define a remote event on the Studio, you will need to set a creative on one of the playlists inside of a screen. That will creative won’t be a part of the running playlist, but will appear only when triggered by the gong event.

Create a Dynamic Creative:

Download the example creative Download Creative
Import the creative to the Studio account by dragging the file to the Media Center on the main “Creatives” tab.

Setting a Remote Event Creative:

Go to a relevant playlist played on target screen
Add the dynamic creative which will be triggered by the Gong remote event.
Click on the creative scheduling button:
On the scheduling modal window set the configuration as following:
- Enable “events”.
- Check the “Play only on events” checkbox – this will prevent the creative from being displayed as part of the playlist and will force it to appear only when its chosen event happens.
- Set the DYNAMIC_EVENT – this is the “Gong” event that will be sent to the media player and will trigger the dedicated creative.
Once a creative event is set and updated on the playlist, restart the media player.

Player App Settings:

In the player app entrance screen, set a screen key which contains a playlist with the dynamic creative configured
Go to the settings (click the gear icon in the top right corner of the screen) and scroll down to the “API Server” section, then choose “Connection Parameters”:
Enable the “Server Events” and type the chosen channel ID from the Notification JSON in the “Channel ID” option:
After the settings are configured, exit the setting screen and then press “Go” to play the content.