PLAYipp Monitoring API

PLAYipp Monitoring API - Produkt specifikation:

PLAYipp Monitoring API ger dig tillgång till live-status och nyckelaktivitetsdata om dina digital signage spelare — vilket gör att du kan hämta och använda informationen från dina egna verktyg, instrumentpaneler eller övervakningsplattformar. Denna guide hjälper dig att förstå hur API:et fungerar, hur du kommer igång och vad du kan använda det till.

Oavsett om du är en partner som integrerar PLAYipp med dina egna övervakningsverktyg som Network Operations Center (NOC) eller Security Operations Center (SOC) plattformar, eller en kund som vill automatisera övervakning av drifttid och IT-felsökning över många skärmar och platser, ger detta API dig ett snabbt och pålitligt sätt att spåra status, aktivitet och teknisk metadata över ditt skärmnätverk.

Vad kan du använda API:ett till

Detta API är specifikt utformat för att stödja:

Centraliserad övervakning av alla spelare från en enda instrumentpanel
Real-tidsdetektering av driftstopp eller anslutningsproblem
Integration med IT-övervakningssystem (NOC/SOC-verktyg, etc.)
Automatisering av varningar, hälsorapporter eller ticketing-arbetsflöden
Insamling av enhetsmetadata (IP, modell, OS, programvaruversion, etc.)

Vem som bör använda detta API

IT-team som hanterar skärminfrastruktur på flera platser
Tjänsteleverantörer (MSP) som erbjuder digital skyltverksamhet
Utvecklare som bygger instrumentpaneler, analyser eller supportverktyg för PLAYipp
Säkerhets- och driftteam som behöver automatiserad insyn i drifttid

Innan du börjar

Offentlig API-åtkomst är aktiverad för ditt konto
Observera: Offentlig API-åtkomst är inaktiverad som standard. Kontakta PLAYipp Support för att aktivera denna funktion.
Du har din personliga API-nyckel
Tillgänglig under Personliga inställningar när API-funktionen är aktiverad
Du har en REST-klient installerad
Vi rekommenderar Postman eller curl
Du är medveten om hastighetsbegränsningarna som finns i dokumentationen.

Swagger & API-testverktyg

För att utforska och testa API:et, kolla in Swagger-dokumentationen:
https://signage.playipp.com/api/public/docs

Autentisering

Alla förfrågningar måste inkludera rätt headerformat:
Authorization: Bearer YOUR_API_KEY
Exempel: Authorization: Bearer abc123xyz456

Vanligt misstag: Använda authentication: istället för Authorization: kommer att resultera i 400 Bad Request. Se felsökning nedan.

Tillgängliga slutpunkter

1. Hämta kunder

Returnerar en lista över alla kunder med deras unika ID:n.

Slutpunkt
GET /api/v1/customers

Exempel på svar

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

2. Hämta skärmar efter kund

Returnerar metadata och live-status för alla skärmar kopplade till en kund.

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

Vägparameter
companyId: Heltal (obligatoriskt)

Exempel på svar

[
{
"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"
}
]

Exempel på användning

Visa skärmens drifttid på en intern instrumentpanel
Flagga skärmar som inte har kontaktat servern på över 60 sekunder
Matcha skärmens metadata (IP, modell, OS) för att felsöka problem
Filtrera skärmar efter kund för att automatisera rapportering

Felsökning

A) Autentiseringsproblem: Du får ett 400 Bad Request eller 403 Forbidden fel:

Headernyckeln måste vara: Authorization
Headervärdet måste vara: Bearer YOUR_API_KEY

Exempel: Authorization: Bearer abc123xyz456
(Använd inte authentication: YOUR_API_KEY)

b) Se till att offentlig API-åtkomst är aktiverad för ditt konto och att din API-nyckel är korrekt.

Kontakt: Om du har frågor eller behöver hjälp, kontakta support@playipp.com, starta en chatt eller ring oss direkt. Vi hjälper gärna till.

Var den här artikeln användbar?