API Overview (Coming Soon)

API Overview

The GoVista API lets you integrate digital signage management into your own applications, websites, and business systems.

Base URL

All API requests are made to:

`` https://api.govista.app/v1/ ``

Authentication

Authenticate requests using an API key in the Authorization header:

`` Authorization: Bearer YOUR_API_KEY ``

Generate API keys from Settings > API > API Keys. See the API Keys article for details.

Rate Limits

| Key Scope | Rate Limit | |-----------|------------| | Read | 100 requests/minute | | Write | 30 requests/minute | | Admin | 30 requests/minute |

When rate limited, the API returns HTTP 429 with a Retry-After header.

Response Format

All responses use JSON:

``json { "success": true, "data": { ... }, "meta": { "page": 1, "total": 100 } } ``

Error responses:

``json { "success": false, "error": { "code": "DEVICE_NOT_FOUND", "message": "The requested device does not exist." } } ``

Pagination

List endpoints support pagination:

`` GET /v1/devices?page=1&limit=20 ``

Available Endpoints

• Devices — /v1/devices — List, create, update, delete devices
• Content — /v1/content — Upload, list, manage media assets
• Playlists — /v1/playlists — CRUD operations on playlists
• Schedules — /v1/schedules — Create and manage schedules
• Stores — /v1/stores — Manage physical locations
• Analytics — /v1/analytics — Query performance data
• Commands — /v1/commands — Send remote commands

SDKs and Libraries

Official client libraries are planned for the public launch:

• JavaScript/TypeScript (npm)
• Python (pip)
• PHP (Composer)

Webhooks

Receive real-time event notifications. See the Webhooks article for configuration details.