Using APIs

This article will outline how TrouDigital’s studio API system can streamline content design and live data broadcasting.

What is an API?

An API (Application Programming Interface) allows software systems to communicate with each other. The API is used to communicate with the studio system.

Parameters

A parameter is a placeholder inside a creative that gets filled with live data when the creative plays. Instead of manually typing out text, URLs and making individual creatives for each site, the parameter pulls data from the data source.

Data Source

The parameter pulls data from a source. This source can vary from a Google Sheet, to a JSON API, to a file in an FTP folder.

During playback, the parameter dynamically loads the content from the data source. 

Bringing Data In: Google Sheets or JSON API

We recommend using Google Sheets where data will be managed and edited by a non-technical user.

This works best for data such as site names, opening times, welcome messages, local contact details, and branch-specific links.

We recommend using JSON API where data is automated or structured. It scales with volume and handles complex data.

This works best for data such as property listings, live product data, ad serving IDs, CRM data, room bookings, weather, transport and stock.

Changing What Plays

There are two ways of changing the content that plays on screens, using the same creative.

Time-based changes occur when the data source updates — every screen picks up the new value automatically. Expect at least a minute for the message to reach the player. Best for live pricing, room bookings, and today’s menu.

Player-based changes mean that, depending on the location of the player, different content is presented from the same creative. Best for site welcome messages, property branches, and local contacts.