# QL API Documentation


The Navori QL API gives you the ability to create custom interfaces that match your exact needs, both from a server/client side aspect .
The Navori QL API has been implemented, using the HTTP protocol, so you can integrate it with your preferred programming language and tools.
The Navori QL API is based on Representational State Transfer (REST) protocol.
The Navori QL API uses the JSON model for all transactions.
The use of Navori QL API, requires the API Addon which you can request from the Navori Extranet.

How to use?

We list on this page all Navori QL API functions, with a simple explanation of each parameter and an example of how to use it.
We have splited the functions in logical parts based on the different windows of the Navori QL interface.
Some parameters are mandatory, others are optional as further mentioned .
Each function returns a status response.
Most functions are divided into three parts: GET / SET / DELETE. These functions use arrays to simplify the flow.
Prior to call any of the Navori QL API functions, you need to get an access token from the GetToken function.
In order to retrieve this token, you will have to use your Navori QL credential.

Go one step further...

To simplify the use of Navori QL API, we have created a set of full working samples that will allow you to:
Log in
Retrieve groups architecture
Retrieve media contents per group
Retrieve playlist per group
Retrieve timeslot per group
Upload Media
Create Playlists
Create/Retrieve/Edit server feeds
Interact with players by launching trigger, reboot, screen on/off and much more...
You can test and use these samples written in Javascript here.
For any technical questions, you can contact the Navori team at this address: support.api@navori.com