App Developer - Get Started

App Developer - Get Started

These instructions are essential for developers looking to build or integrate apps using Q-Play’s platform. By ensuring you have developer rights, you unlock access to tools and resources needed for app development. OAuth2 integration is a critical step because it allows secure interaction with the Q-Play API, enabling developers to retrieve or send data as needed. Tools like Postman make it easier to test and work with APIs, helping developers to streamline and automate their processes.

Before Developing apps 

The following may be relevant to read before starting development:
  1. Ensure you have a Q-Play account with developer rights.
    These rights can be obtained by contacting NordicScreen.
  2. Create an OAuth2 API access and add it to your preferred API tool (e.g., Postman).
    This step involves generating OAuth2 credentials, which will allow you to securely authenticate with Q-Play’s API. After creating these credentials, you can integrate them into an API tool like Postman to make authorized requests to Q-Play services. OAuth2 is a widely-used authorization framework that ensures secure access to external services without exposing sensitive user credentials.

API Access

Step # 1: Get your API Client ID and Client Secret

    1- Login to https://app.q-play.io/

    2- Click on your name and click API from dropdown

    3- Click Create button to create new API Client ID and Secret


Step # 2:  Get Access Token for all next steps

    1- Create a POST request to: {{api_url}}/oauth/token

api_url = https://app.q-play.io/api/rest/v2/

    2- In form-data add following key value pairs:

        i- grant_type: client_credentials

        ii- client_id: CLIENT_ID (from Step 1.3)

        iii- client_secret: CLIENT_SECRET (from Step 1.3)

    3- Send the request and you will get a response like following: 

        {

            "token_type": "Bearer",

            "access_token": "xxxxxxxxxxxxxxxxxxx",

            "expires_in": 3600

        }

    4- You will get an "access_token" that will be valid for 1 hour and you will have to fetch it again after every 1 hour.










    • Related Articles

    • Create WebCapture app

      This guide require a Integration template, read this guide to create integration template. Description: When all is running well you can finally create your app. 1- Send POST request to: {{base_url}}/developer/apps 2- In Body > Raw (json): { "name": ...

    • Mondatory Information for app

      Name App name showed in Q-play to customer. Suggestion: Chose name witch describe the app or the system witch the app integrate with. Requirements: If the app integrate with external systems, the external system name should be clear in the app name ...

    • Understand app types

      This guide outlines the different types of apps available in Q-Play. An app is used to display content within a presentation in the DesignTool. The type of content an app displays depends on its intended function. Below, you will find descriptions of ...

    • Create Integration template

      1. Create Integration Template Description: To create an app this step is the starting point, which allows you to give a name to your app, what is the type of your app and what parameters your app needs to bring proper data to q-play screens. For a ...

    • Create Web app

      Comming