Skip to content
viewneo Docs
CtrlK

viewneo API

With the viewneo API you control your account from your own systems: upload media, fill playlists, activate players and retrieve proof of play. Typical applications are menus from the POS system, prices from the inventory management system or occupancy from the booking system.

Requirements

Section titled “Requirements”
  • The API plugin is booked (see API plugin). Without a booking, every call responds with 403 SUBSCRIPTION_REQUIRED.
  • An API token or OAuth client from Settings › API access (see Authentication).

Base URL

Section titled “Base URL”
https://cloud.viewneo.com/api/public/v1

With White Label, you can also reach the API at your own address; the exact base URL is shown under Settings › API access.

The first call

Section titled “The first call”
Terminal window
curl https://cloud.viewneo.com/api/public/v1/devices \
  -H "Authorization: Bearer $API_TOKEN"

If a list of your devices comes back, everything is set up.

The complete reference

Section titled “The complete reference”

All endpoints with parameters, responses and error codes are listed in the interactive reference at /api/public/v1/docs, so on viewneo at cloud.viewneo.com/api/public/v1/docs. The description in OpenAPI 3 format is available at /api/public/v1/openapi.json – for Postman, Insomnia, Bruno or a code generator.

Versioning

Section titled “Versioning”

The version is in the path (/v1). Within v1, only backward-compatible changes are added: new endpoints, new optional parameters, new fields in responses. Build your client so that it ignores unknown fields. Breaking changes get a new version.

Next

Section titled “Next”