Getting Started With Q‑Play API

Getting Started With Q‑Play API

The Q‑Play API allows you to integrate your own systems, automations, or apps with Q‑Play data and functionality. Before you can get started, you need API credentials that authorize your integration to communicate with the Q‑Play platform.

This article explains how to request API access and where to find the API documentation once your key is active.

What Are Q‑Play API Credentials?

API credentials consist of a secure key issued to your Q‑Play account.
They allow your applications or integrations to:

  1. Retrieve player information
  2. Control or update data in your account
  3. Fetch real‑time or scheduled data
  4. Communicate with Q‑Play through the official API endpoints

Because API keys provide direct access to your account, they must be handled securely and only shared with trusted systems.

How to Request Your Q‑Play API Key

At the moment, API keys are not automatically generated inside Q‑Play.

To obtain one, simply follow these steps:

1. Contact NordicScreen Support

Send an email to:



Include the following information:
  1. Your name and company
  2. The Q‑Play account the key should be created for
  3. A short description of how the API key will be used
  4. (e.g., “Used for Player Monitoring integration”, “Pulling player status into internal dashboards”, “Automated content deployment”, etc.)

This helps the NordicScreen team understand your use case and ensure the API is used safely.


2. Wait for Approval and Key Delivery

Once the request is processed, Support will provide:

  1. Your API key (found in the API section of app.q-play.io - never via email)
  2. Any additional details required for your integration
  3. Confirmation that API access is active on your account


Where to Find the API Documentation

As soon as your API key is active, you can access the official Q‑Play API documentation here:


The documentation includes:
  1. Authentication instructions
  2. Endpoints and parameters
  3. Example requests
  4. Error codes and troubleshooting guidance

This is your primary reference for building integrations.


Security Best Practices

To keep your account secure, please follow these recommendations:

  1. Never share your API key publicly or include it in unprotected code repositories.
  2. Store the key in secure environments (Azure Key Vault, environment variables, encrypted secrets, etc.).
  3. Rotate the key periodically if used in automated systems.
  4. Contact support immediately if you suspect your key has been exposed or misused.

Need help?

If you have questions about the API, need help building an automation, or want to request additional integrations, the NordicScreen Support team is always ready to assist:

    • Related Articles

    • App Developer - Get Started

      Before developing apps, the following resources may be helpful: Understand Q-Play terminology by reading ourQ-Play Directory. Review the documentation and use cases on NordicScreen Q-Play Developer on GitHub. Ensure you have a Q-Play account with ...

    • SharePoint Docs - Show Your PowerPoint, Word and Excel SharePoint Documents In Q-Play

      Introduction This guide will show you how to integrate an Excel file stored in Microsoft SharePoint into Q-Play, so you can pull data directly from the Excel file into your presentation and display it on a screen. The guide is divided into two main ...

    • Q-Play Dictionary

      This guide provides an introduction to Q-Play’s terminology and concepts that users will encounter while working with Q-Play. The dictionary can be used to understand the many features and functionalities that Q-Play offers. Player A player refers to ...

    • How to use FrontDesk app in Q-Play

      By integrating Frontdesk with Q-Play, you can display real-time queue numbers and messages directly on your digital signage screens.This provides a smoother and more informative experience for both staff and visitors. The integration ensures that ...

    • How to Use Design Policy in Q-Play

      Introduction This guide will help you customize your company's design policy in Q-Play. We will go through how to adjust app languages and tailor brand colors to ensure that your apps are not only functional but also visually represent your brand ...