With the API access add-on you manage your screens, playlists, schedule and reports from your own systems: the menu image updates when a price changes in your ERP, your campaign tool uploads and publishes the new poster, your BI tool pulls the proof-of-play report every night. The add-on is included in V-Premium; on other plans turn it on from the Add-ons page.
Technical details (endpoints, sample code) are in the developer docs: developers.viswoo.com/en/api. This page covers the panel side.
Creating a key
- Open Add-ons → API access. Only the account owner and admins manage keys.
- Press Create key and enter the name of the system that will use it (e.g. “ERP”).
- Choose only the permissions it needs. A system that updates price screens, for example, only needs Manage content.
- Choose how long it is valid (90 days, 1 year or no expiry) and press Create.
- Copy the key right away and pass it securely to whoever builds the integration. It will not be shown again.
The key belongs to your business, not a person: it keeps working when the person who created it leaves the team. Turn off a key you no longer use, or suspect has leaked, right away with Revoke.
Permissions
| Permission | What it can do |
|---|---|
| Read screens | See locations, screens, live status and screenshots |
| Manage screens | Change screen settings, refresh or reboot screens |
| Read content | See media, playlists and the schedule |
| Manage content | Upload media, change playlists and the schedule, send emergency alerts |
| Read reports | Get proof-of-play and uptime reports (also needs the Reports add-on) |
| Manage webhooks | Manage event notification addresses |
Changes made with a key go live right away as if an admin made them and appear in the audit log as “API: key name”.
Webhooks
A webhook is Viswoo notifying your server when something happens: a screen went offline or came back, uploaded media was processed, a change awaits approval. In the Webhooks section of the same page:
- Press Add address, enter an address starting with https and choose the events.
- Copy the signing secret shown and save it on your server; you use it to verify requests from Viswoo.
- Try the connection with Send test; Deliveries shows the last 7 days.
If your server doesn’t answer, Viswoo retries for about 24 hours. An address that fails many times in a row is paused and you get an email; fix the problem and turn it back on with Edit.
FAQ
I lost the key. It can’t be shown or recovered. Create a new key and revoke the old one.
Is there a request limit? 120 requests per minute per key. Normal integrations don’t come close.
What if I turn the add-on off? Keys aren’t deleted but stop working; turn the add-on back on and they continue.
Still have questions? Write to us