The NoviSign API allows you to connect NoviSign with external systems, applications, and data sources. Using the API, you can automate actions, trigger events, and control screen behavior based on inputs from other platforms.
This article serves as an introductory guide to the NoviSign API and explains what it is, how it is used, and how to get started.
An API (Application Programming Interface) allows software systems to communicate with each other.
In NoviSign, the API enables external systems to interact with your account and players without manual actions in the Studio. Instead of logging in and triggering actions manually, an external system can send requests to NoviSign, which then performs predefined actions automatically.
Using the NoviSign API, you can:
Trigger Events on screens
Control screen behavior from external systems
Update content dynamically
Automate workflows that would otherwise require manual intervention
The API is intended for developers, system integrators, and technical partners.
The NoviSign API works in addition to the Studio, not instead of it.
All content and structure are still created in the Studio, including: Creatives, Playlists, Screens, Events
The API is then used to trigger, update, or control these existing elements automatically from an external system.
An Event is configured in the Studio to change screen content.
When an external system sends a request to the NoviSign API, the Event is triggered automatically on the relevant screens.
The API does not create layouts or design content. It is used solely to control and activate content that already exists in the account.
Getting started with the NoviSign API typically involves the following steps:
Prepare your API source
Create or obtain the API that will send requests to NoviSign. This may be an internal system, a third-party service, or a custom application.
Configure the API in NoviSign Studio
In the Studio, define how NoviSign should respond to incoming API requests. This usually includes:
Creating or configuring Events
Defining the actions to be triggered on screens
Associating the configuration with the relevant content or screens
Apply the configuration to players
Using Configurations, apply the API-related settings to the target players so they can receive and respond to API-triggered actions.
Test before going live
Test the integration on non-production screens to confirm that API requests trigger the expected behavior.
For detailed, step-by-step instructions with screenshots and configuration examples, see:
NoviSign External API Guide: From Studio Configuration to Player Setup
The following examples demonstrate real-world uses of the NoviSign API and can be used as reference implementations.
Demonstrates how NoviSign integrates with an external transportation system to trigger Events and update content dynamically.
View the sample project on GitHub
Demonstrates how to use the NoviSign Event API to trigger screen actions programmatically.
Using the API requires technical knowledge and development resources.
Always test integrations on non-production screens before deploying them to live environments.
API availability and behavior may depend on your account configuration and permissions.
If you’re unsure whether the API is the right solution for your use case or need assistance getting started, please contact NoviSign Support. We’ll be happy to help.
