Documentación de la API

La API de YourBrandOnTime proporciona acceso programático a nuestra plataforma de Video Social Listening. Con nuestra API RESTful, puedes integrar datos de menciones de marca, análisis de sentimiento, seguimiento de influencers y detección de tendencias directamente en tus propias aplicaciones, dashboards y flujos de trabajo. La API está disponible para todos los suscriptores de planes de pago. Cada nivel de plan incluye un nivel diferente de acceso a la API con diferentes límites de velocidad y disponibilidad de endpoints. Toda la comunicación de la API está cifrada mediante HTTPS y todo el procesamiento de datos se realiza dentro de la Unión Europea en nuestra infraestructura de Scaleway en Francia. URL base: https://api.yourbrandontime.com/v1 La API sigue convenciones REST, devuelve respuestas JSON y utiliza códigos de estado HTTP estándar para el manejo de errores.

Todas las solicitudes de la API deben autenticarse utilizando un token de API. Puedes generar y gestionar tus tokens de API desde el dashboard de YourBrandOnTime en Configuración > Acceso API. Incluye tu token de API en la cabecera Authorization de cada solicitud: Authorization: Bearer tu_token_api_aquí Los tokens de API están vinculados a tu cuenta y heredan los permisos de tu plan de suscripción. Puedes crear múltiples tokens con diferentes nombres para diferentes integraciones y revocarlos individualmente en cualquier momento. Buenas prácticas de seguridad: • Nunca expongas tu token de API en código del lado del cliente o repositorios públicos • Rota tus tokens periódicamente • Usa variables de entorno para almacenar tokens en tu aplicación • Cada token debe usarse para una sola integración o servicio

Los límites de velocidad de la API dependen de tu plan de suscripción: Plan Starter: • 100 solicitudes por minuto • 5.000 solicitudes por día • Acceso a endpoints principales (menciones, sentimiento) Plan Professional: • 500 solicitudes por minuto • 50.000 solicitudes por día • Acceso a todos los endpoints incluyendo seguimiento de influencers y tendencias • Soporte de webhooks Plan Enterprise: • 2.000 solicitudes por minuto • Solicitudes diarias ilimitadas • Acceso a todos los endpoints • Soporte de webhooks con entrega garantizada • Soporte API dedicado La información de límites de velocidad se incluye en las cabeceras de respuesta de cada llamada a la API: • X-RateLimit-Limit: Límite de velocidad de tu plan • X-RateLimit-Remaining: Solicitudes restantes en la ventana actual • X-RateLimit-Reset: Marca de tiempo Unix cuando el límite se restablece Si excedes tu límite de velocidad, la API devolverá una respuesta 429 Too Many Requests. Recomendamos implementar retroceso exponencial en tu integración.

Menciones GET /v1/mentions — Listar menciones de marca en todas las plataformas monitorizadas GET /v1/mentions/:id — Obtener detalles de una mención específica GET /v1/mentions/stats — Obtener estadísticas agregadas de menciones Sentimiento GET /v1/sentiment — Obtener análisis de sentimiento de tus menciones de marca GET /v1/sentiment/timeline — Obtener tendencias de sentimiento a lo largo del tiempo GET /v1/sentiment/breakdown — Obtener desglose de sentimiento por plataforma, idioma o región Influencers GET /v1/influencers — Listar creadores que mencionan tu marca GET /v1/influencers/:id — Obtener perfil detallado de un influencer específico GET /v1/influencers/:id/mentions — Obtener todas las menciones de un influencer específico Tendencias GET /v1/trends — Obtener temas de tendencia relacionados con tu marca GET /v1/trends/emerging — Obtener tendencias emergentes GET /v1/trends/compare — Comparar tendencias entre marcas o períodos Informes POST /v1/reports — Generar un informe personalizado GET /v1/reports/:id — Obtener un informe generado GET /v1/reports/:id/download — Descargar un informe en formato PDF o CSV Webhooks POST /v1/webhooks — Registrar un endpoint de webhook GET /v1/webhooks — Listar webhooks registrados DELETE /v1/webhooks/:id — Eliminar un webhook Cuenta GET /v1/account — Obtener detalles de cuenta y estadísticas de uso GET /v1/account/usage — Obtener métricas detalladas de uso de la API

Proporcionamos bibliotecas cliente oficiales para facilitar la integración: • SDK JavaScript/TypeScript (npm) • SDK Python (PyPI) Hay bibliotecas mantenidas por la comunidad disponibles para Go, Ruby y PHP. Recursos adicionales: • Referencia interactiva completa de la API: docs.yourbrandontime.com • Colección Postman disponible para descarga desde tu dashboard • Catálogo de eventos de webhook y esquemas de payload en nuestra documentación para desarrolladores • Changelog y guías de migración para actualizaciones de versión de la API Para preguntas sobre la API o soporte de integración, contáctanos en info@yourbrandontime.com con el asunto "Soporte API".