Q‑Play API’et giver dig mulighed for at integrere dine egne systemer, automationer eller apps med Q‑Play‑data og funktionalitet. Før du kan komme i gang, skal du have API‑legitimationsoplysninger, som giver din integration adgang til at kommunikere med Q‑Play‑platformen.
Denne artikel forklarer, hvordan du anmoder om API‑adgang, og hvor du finder API‑dokumentationen, når din nøgle er aktiv.
Hvad er Q‑Play API‑legitimationsoplysninger?
API‑legitimationsoplysninger består af en sikker nøgle, der udstedes til din Q‑Play‑konto.
De gør det muligt for dine systemer eller integrationer at:
- Hente playerinfo
- Styre eller opdatere data i din konto
- Hente realtids‑ eller planlagte data
- Kommunikere med Q‑Play via de officielle API‑endpoints
Da API‑nøgler giver direkte adgang til din konto, skal de håndteres sikkert og kun deles med betroede systemer.
Sådan anmoder du om din Q‑Play API‑nøgle:
På nuværende tidspunkt genereres API‑nøgler ikke automatisk i Q‑Play.
For at få en nøgle skal du gøre følgende:
1. Kontakt NordicScreen Support.
Send en e‑mail til:
Inkluder følgende oplysninger:
- Dit navn og din virksomhed
- Den Q‑Play‑konto, som nøglen skal oprettes til
- En kort beskrivelse af, hvordan API‑nøglen skal bruges
- (fx “Bruges til Player Monitoring‑integration”, “Henter player status til interne dashboards”, “Automatiseret indholdsdistribution”, osv.)
Dette hjælper NordicScreen‑teamet med at forstå dit use case og sikre, at API’et bruges korrekt og sikkert.
2. Vent på godkendelse og udlevering af nøgle.
Når din anmodning er behandlet, vil Support give dig:
- Din API‑nøgle (kan findes i API‑sektionen i app.q-play.io – aldrig via e‑mail)
- Eventuel ekstra information, der er nødvendig til integrationen
- Bekræftelse på, at API‑adgangen er aktiv på din konto
Hvor finder jeg API‑dokumentationen?
Så snart din API‑nøgle er aktiv, kan du få adgang til den officielle Q‑Play API‑dokumentation her:
Dokumentationen indeholder:
- Instruktioner om autentificering
- Endpoints og parametre
- Eksempler på forespørgsler
- Fejlkoder og fejlfinding
Det er din primære reference, når du bygger integrationer.
Sikkerheds best practices.
For at holde din konto sikker anbefales det, at du:
- Aldrig deler din API‑nøgle offentligt eller gemmer den i usikrede kode‑repositories
- Opbevarer nøglen i sikre miljøer (Azure Key Vault, miljøvariabler, krypterede secrets osv.)
- Roterer nøglen regelmæssigt, hvis den bruges i automatiserede systemer
- Kontakter support med det samme, hvis du mistænker, at nøglen er blevet kompromitteret
Har du brug for hjælp?
Hvis du har spørgsmål til API’et, brug for hjælp til automations, eller ønsker at anmode om ekstra integrationer, står NordicScreens supportteam klar til at hjælpe: