viewneo API

Mit der viewneo API steuerst du dein Konto aus eigenen Systemen: Medien hochladen, Playlists befüllen, Slides kopieren und ihre Texte und Bilder ändern, Player aktivieren und Abspielnachweise abrufen. Typische Anwendungen sind Speisekarten aus dem Kassensystem, Preise aus der Warenwirtschaft oder Belegungen aus dem Buchungssystem.

Voraussetzungen

• Das Plugin API ist gebucht (siehe API-Plugin). Im Enterprise-Paket ist die API enthalten. Ohne Buchung antwortet jeder Aufruf mit 403 SUBSCRIPTION_REQUIRED.
• Ein API-Token oder OAuth-Client aus Einstellungen › API-Zugang (siehe Authentifizierung).

Basis-URL

https://cloud.viewneo.com/api/public/v1

Mit White Label erreichst du die API auch unter deiner eigenen Adresse; die genaue Basis-URL steht unter Einstellungen › API-Zugang.

Der erste Aufruf

curl https://cloud.viewneo.com/api/public/v1/devices \
  -H "Authorization: Bearer $API_TOKEN"

Kommt eine Liste deiner Geräte zurück, ist alles eingerichtet.

Die vollständige Referenz

Alle Endpunkte mit Parametern, Antworten und Fehlercodes stehen in der interaktiven Referenz unter /api/public/v1/docs, auf viewneo also cloud.viewneo.com/api/public/v1/docs. Die Beschreibung im Format OpenAPI 3 liegt unter /api/public/v1/openapi.json – für Postman, Insomnia, Bruno oder einen Code-Generator.

Versionierung

Die Version steht im Pfad (/v1). Innerhalb von v1 kommen nur rückwärtskompatible Änderungen hinzu: neue Endpunkte, neue optionale Parameter, neue Felder in Antworten. Baue deinen Client so, dass er unbekannte Felder ignoriert. Brechende Änderungen bekommen eine neue Version.

Weiter

• Authentifizierung – Tokens, OAuth und Berechtigungen
• Endpunkte – Bereiche, Seitenaufteilung, Fehler und Limits
• Beispiele – typische Abläufe zum Nachbauen