PHP download

Download the PHP package nordicscreen/q-play-api-client without Composer

On this page you can find all versions of the php package nordicscreen/q-play-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of nordicscreen/q-play-api-client

Informations about the package q-play-api-client

Q-Play API Client

A lightweight PHP client for the NordicScreen Q-Play REST API.

This library provides a convenient PHP interface for authenticating with Q-Play using OAuth2 Client Credentials and calling the various API sections (Media, Players, Presentations, Integrations, etc.).

Requirements

PHP 8.3 or higher
guzzlehttp/guzzle ^7.0
psr/cache ^3.0 (optional, for token caching)

The package uses PSR-4 autoloading under the namespace QPlay\Api\Client.

Installation

Install via Composer:

Getting Started

You will need the following from your Q-Play environment:

API base URL (REST endpoint), for example: https://your-qplay-host.tld/api/rest
OAuth2 Client Credentials: client_id and client_secret
Optional: Scopes required for your use case (ask your Q-Play administrator if unsure)

Basic usage

Notes:

Most API methods return array when the response is JSON, otherwise string (e.g., for binary/stream responses). Handle both accordingly.
Section helpers expose common operations; for advanced endpoints you can still use the generic section methods like get, post, put, patch, and delete.

Token caching (optional but recommended)

You can provide a PSR-6 CacheItemInterface to persist the OAuth2 access token between requests/processes. This minimizes token requests and improves performance.

The client will:

Read the token payload from the cache item if present and valid
Store/update the token and its expiration when a new token is obtained
Clear the cached token if it becomes invalid

Custom HTTP client (advanced)

If you need custom timeouts, proxies, logging, or TLS options, you can pass in your own GuzzleHttp\Client instance:

API Sections overview

The high-level QPlayClient provides typed accessors for the different API sections:

media() — Media Library API (/media)
players() — Players API (/players)
presentations() — Presentations API (/presentations)
events() — Events API (/events)
integration() — Integration API (/integration)
integrationTemplate() — Integration Template API (/integration-template)
app() — App section (read-only)
appTemplate() — App Template section (read-only)
system() — System API (/system)
server() — Server API (/server)
developerApp() — Developer Apps (/developer/apps)
developerAppTemplate() — Developer App Templates (/developer/app-template)
developerIntegrationTemplate() — Developer Integration Templates (/developer/integration-template)

Each section implements convenience methods where available. For endpoints that are not covered by a helper method, you can use the generic methods:

Error handling

All HTTP and validation errors are converted to domain exceptions. You can catch the base QPlay\Api\Client\Exception\ApiException or handle specific cases:

ValidationException
UnauthorizedException
ForbiddenException
NotFoundException
MethodNotAllowedException
TooManyRequestsException
ServerErrorException

Example:

Tips

Scopes: provide only the scopes you actually need; if omitted, the client requests without any scope parameter.
Base URL: always use the REST base (no trailing slash), e.g., https://your-qplay-host.tld/api/rest.
Responses: some endpoints may return non-JSON (e.g., downloads). Treat responses as string|array.

License

This project is released under the MIT License. See LICENSE for details.

All versions of q-play-api-client with dependencies

PHP Build Version

Package Version

Version 0.0.2 Release 23. Mar 2026
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of q-play-api-client from vendor nordicscreen

Requires php Version >=8.1
psr/cache Version ^3.0
guzzlehttp/guzzle Version ^7.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nordicscreen/q-play-api-client contains the following files

Loading the files please wait ...