API Plugin
The API Plugin connects viewneo with your own applications or third-party systems via a REST API. Automate workflows, synchronize data, or control viewneo from external systems.
Prerequisites
Section titled “Prerequisites”- An active viewneo subscription that includes the API Plugin
- Programming knowledge (REST API, OAuth 2.0)
What the API Enables
Section titled “What the API Enables”Through the viewneo API, you can:
- Programmatically create, modify, and delete content
- Manage playlists and devices
- Feed data from external systems into viewneo
- Connect custom dashboards or control interfaces
Security
Section titled “Security”Access to the viewneo API is protected via OAuth 2.0. Only authorized clients can access the API.
Setting Up the API Plugin
Section titled “Setting Up the API Plugin”Step 1: Open the API Section
Section titled “Step 1: Open the API Section”- Navigate to the Dashboard in the top right
- Click on the API tab
Step 2: Set Up an API Client
Section titled “Step 2: Set Up an API Client”On the API page, you can:
- Create and manage clients — these are authorized to use the viewneo API
- Create Personal Access Tokens — for direct API access without the full OAuth flow
Step 3: Use the API
Section titled “Step 3: Use the API”Use the created credentials to communicate with viewneo via the REST API.
Technical Documentation
Section titled “Technical Documentation”The following resources are available for implementation:
| Resource | Description |
|---|---|
| REST API Documentation | Endpoints, parameters, and response formats |
| Authentication | OAuth 2.0 authorization flow and token management |
| Data Models | Structure of viewneo objects (playlists, content, devices, etc.) |
| Examples | Code examples for typical API calls |
Use Cases
Section titled “Use Cases”Corporate — ERP Integration
Section titled “Corporate — ERP Integration”Connect your ERP system with viewneo to automatically display product data, prices, or inventory levels on displays in production or logistics.
Retail — POS Integration
Section titled “Retail — POS Integration”Control screen content based on point-of-sale data — e.g., current top sellers or sales information in real time.
Education — Timetable System
Section titled “Education — Timetable System”Read timetable data from your management system and automatically update room and event displays.
Frequently Asked Questions
Section titled “Frequently Asked Questions”Do I need programming knowledge?
Section titled “Do I need programming knowledge?”Yes. The viewneo API is a REST API accessed via HTTP requests. Basic knowledge of web development and working with APIs is required.
How is the API secured?
Section titled “How is the API secured?”Access is protected via OAuth 2.0. You need a registered client and valid credentials (token) to send requests to the API.
Can I use the API for automation without programming knowledge?
Section titled “Can I use the API for automation without programming knowledge?”For no-code automation, we recommend the Zapier Plugin, which offers a visual integration with numerous third-party services.