Developer home
VISWOO DOCUMENTATION
Changelog
Changes to the SDK, bridges, package format and device protocol.
Viswoo API v1 (October 2026)
Section titled “Viswoo API v1 (October 2026)”- External API for businesses:
/api/ext/v1,vzk_…keys and permissions; screens, content, scheduling with an impact dry run, emergency alerts, reports (introduction, reference). - Signed webhooks: screen, media and approval events with retries and a delivery log (webhooks).
Revenue sharing (October 2026)
Section titled “Revenue sharing (October 2026)”- Earnings on the portal: your share (70%), payable balance, monthly statement and CSV, payout requests with an invoice, payout details (owner only, with two-step verification).
Review and publishing (October 2026)
Section titled “Review and publishing (October 2026)”- Submit a version for review with release notes from the portal; statuses In review and Rejected, the decision note on the portal and by email. An approved version is published right away.
- Analytics on the portal (installs, active, uninstalls, rating) and replies to store reviews.
- Webhook events
uninstalled(when a customer turns the plugin off; the install token stops working) andevent(event counts; only when listed explicitly inserver.events). - The verified publisher badge in the store comes from the publisher’s status.
Developer portal (October 2026)
Section titled “Developer portal (October 2026)”- Developer accounts (publisher and team), plugin code registration, version uploads with two-step verification and a check report (rules, ES5, sizes, permission changes), a free test area.
viswoo-plugin publish: upload from the command line with a developer token (vzd_…).
SDK 0.1.0 (October 2026)
Section titled “SDK 0.1.0 (October 2026)”viswoo-plugin inittemplates:basic,interactive,server.viswoo-plugin devsimulator: panel, TV and phone side by side; platform rules, theme, language, role, resolution, orientation, touch, offline; signed webhooks and a subset of the platform API.- ES5 check in
validateandpack. .viswooignorefor files that stay out of the package.- The phone bridge accepts a
theme.changedevent from its host (used by the simulator; backward compatible).
Protocol 4: placement (October 2026)
Section titled “Protocol 4: placement (October 2026)”player.placementin the manifest: continuous, interval and playlist display; Screens and Preview tabs in the panel.- Server actions return
plugin.not_livewhen the plugin is off or outside its dates. - Protocol 3 players only play the playlist item.
Design standard (October 2026)
Section titled “Design standard (October 2026)”- UI kit (
viswoo-ui.css) and TV kit (viswoo-screen.css); packages without the kits are rejected (plugin.kit_missing). - The panel draws the Settings tab from the schema;
x-viswoo-label,x-viswoo-help,x-viswoo-widget,x-viswoo-visibility. - Setup is incomplete while required settings are missing (
plugin.setup_incomplete). - Draw pools from settings (
draw.pools).
Protocol 3: packaged plugins (October 2026)
Section titled “Protocol 3: packaged plugins (October 2026)”- Package format (
.vzp), panel, screen and phone bridges. - Server actions: draws, one-time codes, event counters; signed webhooks to the plugin’s own server.