PLAYipp Monitoring API

PLAYipp Monitoring API - Produkt spesifikasjon:

PLAYipp Monitoring API gir deg tilgang til live-status og nøkkelaktivitetsdata om dine digitale skiltspillere — noe som gjør at du kan hente og bruke informasjonen fra dine egne verktøy, dashbord eller overvåkingsplattformer. Denne guiden hjelper deg å forstå hvordan API-et fungerer, hvordan du kommer i gang og hva du kan bruke det til.

Uansett om du er en partner som integrerer PLAYipp med dine egne overvåkingsverktøy som Network Operations Center (NOC) eller Security Operations Center (SOC) plattformer, eller en kunde som ønsker å automatisere overvåkingen av oppetid og IT-feilsøking over mange skjermer og steder, gir dette API-et deg en rask og pålitelig måte å spore status, aktivitet og teknisk metadata over ditt skjermnettverk.

Hva du kan bruke API-et til

Dette API-et er spesifikt designet for å støtte:

Sentralisert overvåking av alle spillere fra et enkelt dashbord
Sanntidsdeteksjon av driftsstans eller tilkoblingsproblemer
Integrasjon med IT-overvåkingssystemer (NOC/SOC-verktøy, osv.)
Automatisering av varsler, helserapporter eller ticketing-arbeidsflyter
Innsamling av enhetsmetadata (IP, modell, OS, programvareversjon, osv.)

Hvem som bør bruke dette API-et

IT-team som håndterer skjerminfrastruktur på flere steder
Tjenesteleverandører (MSP) som tilbyr digital skilting
Utviklere som bygger dashbord, analyser eller støtteverktøy for PLAYipp
Sikkerhets- og driftsteam som trenger automatisert innsikt i oppetid

Før du begynner

Offentlig API-tilgang er aktivert for kontoen din
Vennligst merk: Offentlig API-tilgang er deaktivert som standard. Kontakt PLAYipp Support for å aktivere denne funksjonen.
Du har din personlige API-nøkkel
Tilgjengelig under Personlige innstillinger når API-funksjonen er aktivert
Du har en REST-klient installert
Vi anbefaler Postman eller curl
Du er klar over hastighetsbegrensningene som finnes i dokumentasjonen.

Swagger & API-testverktøy

For å utforske og teste API-et, sjekk ut Swagger-dokumentasjonen:
https://signage.playipp.com/api/public/docs

Autentisering

Alle forespørselene må inkludere riktig headerformat:
Authorization: Bearer YOUR_API_KEY
Eksempel: Authorization: Bearer abc123xyz456

Vanlig feil: Å bruke authentication: i stedet for Authorization: vil resultere i 400 Bad Request. Se feilsøking nedenfor.

Tilgjengelige endepunkter

1. Hent kunder

Returnerer en liste over alle kunder med deres unike ID-er.

Endepunkt
GET /api/v1/customers

Eksempel på svar

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

2. Hent skjermer etter kunde

Returnerer metadata og live-status for alle skjermer knyttet til en kunde.

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

Sti parameter
companyId: Heltall (obligatorisk)

Eksempel på svar

[
{
"companyId": 123,
"name": "Resepsjonsskjerm 1",
"type": "skilt",
"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"
}
]

Eksempler på bruk

Vis skjermens oppetid på et internt dashbord
Flagg skjermer som ikke har kontaktet serveren på over 60 sekunder
Matche skjermens metadata (IP, modell, OS) for å feilsøke problemer
Filtrere skjermer etter kunde for å automatisere rapportering

Feilsøking

A) Autentiseringsproblemer: Du får en 400 Bad Request eller 403 Forbidden feil:

Headernøkkelen må være: Authorization
Headerverdien må være: Bearer YOUR_API_KEY

Eksempel: Authorization: Bearer abc123xyz456
(Ikke bruk authentication: YOUR_API_KEY)

b) Sørg for at offentlig API-tilgang er aktivert for kontoen din og at API-nøkkelen din er korrekt.

Kontakt: Hvis du har spørsmål eller trenger hjelp, kontakt support@playipp.com, start en chat eller ring oss direkte. Vi hjelper gjerne til.

Var denne artikkelen nyttig?