Ayuda HTML5 integration

After Vistar’s HTML5 asset is scheduled in the Ayuda platform as an HTML5 ad copy, it handles the communication between your Ayuda player and Vistar’s ad server. This solution requests ads, receives ads, and reports back proof of plays (PoPs) for each Ayuda player. This article provides an overview of how to work with Vistar to provide the required information for the integration and how to set up your player to ensure that the HTML5 asset works properly.

Note: You may not be able to leverage certain Splash player functionality through the Vistar HTML5 asset integration.  

The following diagram shows a simplified version of an Ayuda HTML5 integration.


Complete the following steps in this article:

1. Provide required information

The following information is collected during the onboarding process with Vistar:

  • What is the Face ID for each player? Note: We do not support more than one Face ID for the same player.
  • Does your network support static, video, or both?
  • Do the venues support audio?
  • What is the supported width and height of creatives?
  • What is the duration for the Vistar spot?
    • Vistar only supports a single spot duration, requiring all static and video creatives to have the same duration
  • Do you have an approved test creative that is the same aspect ratio as your test screen?
  • What Splash Player version are you using?
  • What operating system (OS) are you using (Windows or Linux)?
  • What is the connection speed of your devices?
  • Are your devices connected to the internet through a wired or wireless connection?
  • What is your bandwidth limit per month?
  • Do you have any firewall settings?
  • What FTP server type do you use? Note that Vistar supports ftp, vsftp, pure-ftp, ws_ftp, sftp.
2. Schedule the provided HTML5 asset

Vistar configures the asset in the backend based on the required information you provided. Vistar sends the HTML5 asset to your team to have it scheduled in the Ayuda platform.

Note: Please schedule the HTML5 asset as an HTML based spot and not in a media bundle. 

3. Configure the splash player

The HTML5 asset is designed to run within a Chromium framework. While Ayuda provides a Chromium framework for Splash, it is not necessarily the default setting. In order to get the HTML5 asset running, confirm that the player is using the following configuration with Chromium:

  1. Open the player in Splash, click NOC, and then click Players.
  2. Confirm that the Configuration Model field is set to a model with CEF enabled. For example, there should be an option called “Chromium HDMI.”
  3. Click Save.

Then, ensure that the splash player model is set to the following:

  1. Open the player in Splash, click Configuration, and then click Configuration Models.
  2. Confirm that the Prioritize CEF over Legacy Browser field is set to Yes and that the CEF Arguments field is enabled.


After your asset is running, Vistar can proceed with the Initial Integration Test. Complete the following procedure to set up Forward & Store to use an FTP server.

4. Set up Forward & Store

Ayuda has a feature called Forward & Store. When creatives are added to your FTP server, Forward & Store enables these creatives to be sent from your FTP server and stored locally on your players. This helps to make sure that creatives from campaigns targeting your device are cached on devices in advance, rather than attempting to download them in real-time. Vistar has an automated process that allows us to push creatives to your FTP server. This is important especially for large creatives or for devices with poor internet connectivity.

The following must be configured in the Ayuda platform for Forward & Store to work properly:

  • Enable Forward & Store—This should say Forward & Store to show that it is enabled.
  • Player Target Folder Name—This is the file path where creatives are stored locally on the device, which should be vistar. Note that this is case-sensitive.
  • FTP Directory—This is the file path where creatives are stored in your FTP server. The path should be vistar/assets.


View the next section to help Vistar set up your FTP sync task.

5. Set up your FTP sync task

The frequency of pushing creatives to your FTP server is every hour. The FTP sync task adds these creatives to the vistar/assets folder in your FTP server. The Forward & Store feature in Ayuda sends the creatives from your FTP server and stores them locally on your players. Every time the Vistar spot is reached in the loop, the asset retrieves the locally cached version of the creative that was sent in the ad response. If the creative has not been cached, the asset will skip to the next spot. The Vistar team needs the following information to set up your FTP sync task:

  • Hostname—The URL of the FTP server. For example, xxx.compute-1.amazonaws.com.
  • Port—The default port for sending commands.
  • Username—Name used to connect to the server.
  • Password—Password set by the user to connect to the server.
  • Display resolution—Sizes of the screen, which can be one or more. For example, 1920x1080 (landscape).
  • Screenshot of your Forward and Store configuration—This is found in the Ayuda platform.

After this information is provided, Vistar configures the set up in the background to sync qualifying creatives to your FTP server.


If you plan to make any changes to your FTP server (such as changing the hostname), notify Vistar at least two weeks in advance. If changes are made to the FTP server without notifying Vistar, this will affect campaigns targeting your devices.

6. Schedule asset to run using the FTP server

Schedule the asset using the FTP server and then work with Vistar to run the Certification Test.

Was this article helpful?
2 out of 5 found this helpful