PHPackages                             nordicscreen/q-play-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. nordicscreen/q-play-api-client

ActiveLibrary[API Development](/categories/api)

nordicscreen/q-play-api-client
==============================

0.0.2(3mo ago)01.6k↑94.6%MITPHPPHP >=8.1

Since Dec 10Pushed 3mo agoCompare

[ Source](https://github.com/NordicScreen/qplay-api-client)[ Packagist](https://packagist.org/packages/nordicscreen/q-play-api-client)[ RSS](/packages/nordicscreen-q-play-api-client/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (2)Dependencies (4)Versions (4)Used By (0)

Q-Play API Client
=================

[](#q-play-api-client)

[![License: MIT](https://camo.githubusercontent.com/fdf2982b9f5d7489dcf44570e714e3a15fce6253e0cc6b5aa61a075aac2ff71b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d79656c6c6f772e737667)](LICENSE)

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
------------

[](#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
------------

[](#installation)

Install via Composer:

```
composer require nordicscreen/q-play-api-client

```

Getting Started
---------------

[](#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

[](#basic-usage)

```