Premiers pas

API de la plateforme

Avec l'API, vos systèmes consultent les TVs, les fichiers et les playlists de votre compte sans ouvrir le panneau de contrôle. Utilisez-la pour afficher le statut des TVs dans votre outil de supervision, vérifier ce qui passe sur chaque écran ou créer des rapports.

Chaque clé voit exactement ce que son utilisateur voit dans le panneau de contrôle : les mêmes organisations et, dans chaque organisation, ce que ses permissions lui permettent de lister.

Lecture seule

Dans cette version, l'API sert uniquement à consulter. Rien n'est modifié dans votre compte.

Mêmes accès que le panneau

Une permission retirée dans le panneau de contrôle s'applique immédiatement à l'API.

JSON sur HTTPS

Réponses en JSON et dates au format ISO 8601 avec fuseau horaire.

Format des réponses

Les réponses sont en JSON (UTF-8). Un élément est renvoyé dans data ; les listes contiennent aussi meta, avec la pagination.
Les dates sont au format ISO 8601 avec le fuseau horaire, par exemple 2026-11-03T14:32:10-03:00.
Chaque élément possède un uid, le même que dans le panneau de contrôle. Utilisez-le pour consulter l'élément par la suite.
Un champ sans valeur est renvoyé avec null. De nouveaux champs peuvent être ajoutés à tout moment : ignorez ceux que vous ne connaissez pas.

Pour commencer

1Authentification: générez une clé dans Mon compte › API et envoyez-la dans l'en-tête X-API-Key.
2Votre utilisateur: faites une première requête pour tester la clé.
3Ce que chaque utilisateur peut voir: vérifiez quelles organisations et quels éléments la clé peut consulter.

URL de base

https://api.on-cloud.live/v1

Ce que vous pouvez consulter

/mevotre utilisateur et la clé utilisée
/organizationsorganisations et permissions
/tvsTVs et leur statut
/filesfichiers téléversés
/playlistsplaylists et leurs éléments

Première requêtecURLPHPJavaScript

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Réponse200

{
  "data": {
    "uid": "3c59dc048e8850243be8079a5c74d079",
    "name": "Mariana Souza",
    "email": "mariana@exemplo.com.br",
    "language": "pt_BR",
    "api_key": {
      "name": "Monitoramento",
      "prefix": "apk_527d541b",
      "created_at": "2026-11-01T09:15:42-03:00",
      "last_used_at": "2026-11-03T14:31:58-03:00"
    }
  }
}