PLAYipp Monitoring API

PLAYipp Monitoring API - Product Specification:

The PLAYipp Monitoring API gives you access to live status and key activity data about your digital signage players — allowing you to fetch and use the information from your own tools, dashboards, or monitoring platforms. This guide helps you understand how the API works, how to get started, and what you can use it for.

Whether you're a partner integrating PLAYipp with your own monitoring tools such as Network Operations Center (NOC) or Security Operations Center (SOC) platforms, or a customer looking to automate uptime monitoring and IT troubleshooting across many screens and sites, this API gives you a fast and reliable way to track status, activity, and technical metadata across your screen network.

What You Can Use the API For

This API is purpose-built to support:

Centralized monitoring of all players from a single dashboard
Real-time detection of downtime or connectivity issues
Integration with IT monitoring systems (NOC/SOC tools, etc.)
Automation of alerts, health reports, or ticketing workflows
Device metadata collection (IP, model, OS, software version, etc.)

Who Should Use This API

IT teams managing screen infrastructure across multiple locations
Managed Service Providers (MSPs) offering digital signage operations
Developers building dashboards, analytics, or support tools for PLAYipp
Security and operations teams who need automated visibility into uptime

Before You Begin

Public API access is enabled for your account
Note: Public API access is disabled by default. Contact PLAYipp Support to enable this feature.
You have your personal API key
Available under Personal Settings once the API feature is enabled
You have a REST client installed
We recommend Postman or curl
You're aware of the rate limits found in the documentation.

Swagger & API Testing Tools

To explore and test the API check out the Swagger Documentation:
https://signage.playipp.com/api/public/docs

Authentication

All requests must include the correct header format:
Authorization: Bearer YOUR_API_KEY
Example: Authorization: Bearer abc123xyz456

Common mistake: Using authentication: instead of Authorization: will result in 400 Bad Request. See troubleshooting below.

Available Endpoints

1. Get Customers

Returns a list of all customers with their unique IDs.

Endpoint
GET /api/v1/customers

Example Response

[
{
"id": 123,
"name": "PLAYippAccountName"
}
]

2. Get Screens by Customer

Returns metadata and live status for all screens linked to a customer.

Endpoint
GET /api/v1/screens/{companyId}

Path Parameter
companyId: Integer (required)

Example Response

[
{
"companyId": 123,
"name": "Reception Screen 1",
"type": "signage",
"mac": "00:1A:2B:3C:4D:5E",
"ip": "10.2.0.123",
"status": "online",
"latestContact": "2025-01-01 13:37:00",
"latestContactSeconds": 47,
"model": "SSSP11",
"brand": "Samsung",
"softwareVersions": {
"com.samsung.ssp": "1.0.0",
"com.samsung.tizen": "5.0"
},
"os": "Tizen",
"createdOn": "2025-01-01 12:00:00"
}
]

Available Endpoints

Show screen uptime on an internal dashboard
Flag screens that haven’t contacted the server in over 60 seconds
Match screen metadata (IP, model, OS) to troubleshoot issues
Filter screens by customer to automate reporting

Troubleshooting

A) Authorization issues: You’re getting a 400 Bad Request or 403 Forbidden error:

Header key must be: Authorization
Header value must be: Bearer YOUR_API_KEY

Example: Authorization: Bearer abc123xyz456
(Do not use authentication: YOUR_API_KEY)

b) Make sure Public API access is enabled for your account and your API key is correct.

Contact: If you have questions or need help, contact support@playipp.com, start a chat, or call us directly. We're happy to assist.

Was this article helpful?