Visión general de la API
Visión general de la API
La API de GoVista te permite integrar la gestión de señalización digital en tus propias aplicaciones, webs y sistemas de negocio.
URL base
Todas las peticiones API se hacen a:
`` https://api.govista.app/v1/ ``
Autenticación
Autentica las peticiones usando una clave API en la cabecera Authorization:
`` Authorization: Bearer YOUR_API_KEY ``
Genera claves API desde Ajustes > API > Claves API. Consulta el artículo de Claves API para más detalles.
Límites de tasa
| Scope de la clave | Límite de tasa | |-------------------|----------------| | Read | 100 peticiones/minuto | | Write | 30 peticiones/minuto | | Admin | 30 peticiones/minuto |
Cuando se aplica límite de tasa, la API devuelve HTTP 429 con una cabecera Retry-After.
Formato de respuesta
Todas las respuestas usan JSON:
``json { "success": true, "data": { ... }, "meta": { "page": 1, "total": 100 } } ``
Respuestas de error:
``json { "success": false, "error": { "code": "DEVICE_NOT_FOUND", "message": "The requested device does not exist." } } ``
Paginación
Los endpoints de listado admiten paginación:
`` GET /v1/devices?page=1&limit=20 ``
Empieza con el scope Read para probar y explorar la API. Sube a Write o Admin cuando estés listo para hacer cambios programáticamente.
Endpoints disponibles
- Devices —
/v1/devices— Listar, crear, actualizar y borrar dispositivos - Content —
/v1/content— Subir, listar y gestionar assets multimedia - Playlists —
/v1/playlists— Operaciones CRUD sobre listas de reproducción - Schedules —
/v1/schedules— Crear y gestionar programaciones - Stores —
/v1/stores— Gestionar ubicaciones físicas - Analytics —
/v1/analytics— Consultar datos de rendimiento - Commands —
/v1/commands— Enviar comandos remotos
SDKs y librerías
GoVista ofrece librerías cliente oficiales para la API:
- JavaScript/TypeScript (npm)
- Python (pip)
- PHP (Composer)
Webhooks
Recibe notificaciones de eventos en tiempo real. Consulta el artículo de Webhooks para los detalles de configuración.
La API está versionada. Incluye siempre /v1/ en tus URLs. Los cambios disruptivos se introducirán en nuevas versiones (v2, v3) con avisos de deprecación para las versiones antiguas.