Salta ai contenuti
viewneo Docs
CtrlK

viewneo API

Con la viewneo API gestisci il tuo account dai tuoi sistemi: caricare file multimediali, riempire playlist, attivare player e recuperare le prove di riproduzione. Applicazioni tipiche sono i menu dal sistema di cassa, i prezzi dal gestionale di magazzino o le occupazioni dal sistema di prenotazione.

Requisiti

Sezione intitolata “Requisiti”
  • Il plugin API è attivato (vedi plugin API). Senza attivazione ogni chiamata risponde con 403 SUBSCRIPTION_REQUIRED.
  • Un token API o un client OAuth da Impostazioni › Accesso API (vedi Autenticazione).

URL di base

Sezione intitolata “URL di base”
https://cloud.viewneo.com/api/public/v1

Con White Label raggiungi l’API anche al tuo indirizzo; l’URL di base esatto è indicato in Impostazioni › Accesso API.

La prima chiamata

Sezione intitolata “La prima chiamata”
Terminal window
curl https://cloud.viewneo.com/api/public/v1/devices \
  -H "Authorization: Bearer $API_TOKEN"

Se ricevi l’elenco dei tuoi dispositivi, è tutto configurato.

Il riferimento completo

Sezione intitolata “Il riferimento completo”

Tutti gli endpoint con parametri, risposte e codici di errore sono nel riferimento interattivo in /api/public/v1/docs, su viewneo quindi cloud.viewneo.com/api/public/v1/docs. La descrizione in formato OpenAPI 3 si trova in /api/public/v1/openapi.json – per Postman, Insomnia, Bruno o un generatore di codice.

Versionamento

Sezione intitolata “Versionamento”

La versione è nel percorso (/v1). All’interno di v1 vengono aggiunte solo modifiche retrocompatibili: nuovi endpoint, nuovi parametri facoltativi, nuovi campi nelle risposte. Costruisci il tuo client in modo che ignori i campi sconosciuti. Le modifiche incompatibili ricevono una nuova versione.

Prosegui

Sezione intitolata “Prosegui”