Aller au contenu
viewneo Docs
CtrlK

API viewneo

Avec l’API viewneo, tu pilotes ton compte depuis tes propres systèmes : téléverser des médias, remplir des playlists, activer des lecteurs et récupérer des preuves de diffusion. Les usages typiques sont des menus issus du système de caisse, des prix issus de la gestion des stocks ou des occupations issues du système de réservation.

Prérequis

Section intitulée « Prérequis »
  • Le plug-in API est réservé (voir plug-in API). Sans réservation, chaque appel renvoie 403 SUBSCRIPTION_REQUIRED.
  • Un Jeton d’API ou un Client OAuth issu de Paramètres › Accès API (voir Authentification).

URL de base

Section intitulée « URL de base »
https://cloud.viewneo.com/api/public/v1

Avec White Label, tu accèdes aussi à l’API sous ta propre adresse ; l’URL de base exacte figure sous Paramètres › Accès API.

Le premier appel

Section intitulée « Le premier appel »
Fenêtre de terminal
curl https://cloud.viewneo.com/api/public/v1/devices \
  -H "Authorization: Bearer $API_TOKEN"

Si une liste de tes appareils est renvoyée, tout est configuré.

La référence complète

Section intitulée « La référence complète »

Tous les endpoints avec leurs paramètres, réponses et codes d’erreur figurent dans la référence interactive sous /api/public/v1/docs, soit, sur viewneo, cloud.viewneo.com/api/public/v1/docs. La description au format OpenAPI 3 se trouve sous /api/public/v1/openapi.json – pour Postman, Insomnia, Bruno ou un générateur de code.

Gestion des versions

Section intitulée « Gestion des versions »

La version figure dans le chemin (/v1). Au sein de v1, seules des modifications rétrocompatibles sont ajoutées : nouveaux endpoints, nouveaux paramètres facultatifs, nouveaux champs dans les réponses. Conçois ton client de sorte qu’il ignore les champs inconnus. Les modifications incompatibles reçoivent une nouvelle version.

Pour continuer

Section intitulée « Pour continuer »