¿Quiere automatizar sus auditorías de visibilidad IA, integrar los resultados en su dashboard interno o conectar AILabsAudit a sus herramientas existentes? La API REST v1 está hecha para eso. Esta guía práctica le acompaña desde su primera petición hasta los patrones de integración avanzados.
¿Por qué integrar la API REST de AILabsAudit?
La interfaz web de AILabsAudit es ideal para uso manual, pero tiene sus límites cuando gestiona decenas de clientes o necesita automatizar flujos de trabajo. La API REST abre posibilidades que la interfaz no puede ofrecer:
- Automatización completa: Lance auditorías programadas vía cron jobs o flujos CI/CD
- Integración dashboard: Muestre las puntuaciones de visibilidad IA directamente en su herramienta de reporting
- Alertas personalizadas: Detecte caídas de visibilidad y notifique automáticamente a sus equipos
- Informes personalizados: Combine datos de AILabsAudit con sus propias métricas para informes enriquecidos
- Sincronización CRM: Vincule los datos de auditoría a sus fichas de clientes en su CRM
Lo que puede hacer con la API
Gestión de clientes
Acceda a todo su portfolio de clientes mediante el endpoint /api/v1/clients. Obtenga detalles, contactos, competidores y la vista 360° completa de cada cliente.
Auditorías y resultados
Lance nuevas auditorías programáticamente con POST /api/v1/audits/launch, siga su progreso y obtenga resultados detallados: puntuaciones de visibilidad, rendimiento por modelo IA, tendencias y comparaciones.
Informes PDF
Descargue informes PDF premium mediante GET /api/v1/reports/{id}/download para integrarlos en sus flujos de entrega automatizados al cliente.
Analíticas y portfolio
Acceda a analíticas avanzadas: vista general del portfolio, ranking de visibilidad, distribución de puntuaciones. Perfecto para construir dashboards de seguimiento multi-cliente.
Quick start en 3 pasos
Paso 1: Crear su clave API
Vaya a Cuenta → API e Integraciones y cree una nueva clave. Comenzará por aila_.
Paso 2: Probar la conexión
Primera petición
curl -H "X-Api-Key: aila_su_clave" https://ailabsaudit.com/api/v1/clientsSi ve su lista de clientes en JSON, ¡todo funciona!
Paso 3: Explorar los endpoints
Consulte el tutorial completo de API REST para descubrir los 8 grupos de endpoints, o explore directamente la documentación Swagger.
Patrones de integración comunes
Auditorías automáticas programadas
El caso de uso más popular: un cron job que lanza una auditoría para cada cliente a intervalos regulares (semanal o mensual), obtiene los resultados y los almacena en su base de datos.
# Ejemplo: auditoría mensual para todos los clientes
import requests
API_KEY = "aila_su_clave"
BASE = "https://ailabsaudit.com/api/v1"
headers = {"X-Api-Key": API_KEY}
clients = requests.get(f"{BASE}/clients", headers=headers).json()
for client in clients["data"]:
requests.post(f"{BASE}/audits/launch",
headers=headers,
json={"client_id": client["id"]})
Dashboard embedding
Integre las puntuaciones de visibilidad en su propio dashboard llamando al endpoint de analíticas:
scores = requests.get(f"{BASE}/analytics/leaderboard", headers=headers).json()
# Muestre en su interfazAlertas de caída de visibilidad
Compare las puntuaciones entre dos auditorías sucesivas y envíe una alerta (email, Slack) si un cliente pierde más de 10 puntos:
audit_history = requests.get(
f"{BASE}/audits?client_id=42&per_page=2",
headers=headers
).json()
# Compare puntuaciones y alerte si es necesarioBuenas prácticas
Respete el rate limiting
La API permite 60 peticiones por minuto por clave. Espacie sus llamadas e implemente backoff exponencial para errores 429. Consulte los headers X-RateLimit-* para monitorizar su consumo.
Cache de respuestas
Los datos de auditoría no cambian frecuentemente. Almacene en caché las respuestas (Redis, archivo local) durante 1 a 24 horas para reducir las llamadas API y mejorar el rendimiento de su aplicación.
Gestione los errores correctamente
La API devuelve códigos HTTP estándar y mensajes de error en JSON. Gestione como mínimo los casos 401 (clave inválida), 429 (rate limit) y 500 (error del servidor).
Asegure su clave
Almacene su clave API en una variable de entorno, nunca en su código fuente. Use claves diferentes por entorno (dev/producción) y revoque inmediatamente una clave comprometida.
Recursos útiles
Para ir más allá
Explore estos recursos para dominar la API REST:
- Tutorial completo de API REST — Guía paso a paso con ejemplos de código
- Documentación Swagger — Referencia interactiva de todos los endpoints
- Glosario: API REST — Definición y conceptos clave
- Guía MCP — Conecte su IA directamente a AILabsAudit
FAQ
¿Qué suscripción se necesita para acceder a la API REST?
La API REST está disponible con los planes Enterprise y Partner. Los planes gratuitos y estándar no incluyen acceso API. Solicite acceso partner para empezar.
¿La API REST usa las mismas claves que MCP?
Sí, es la misma clave API (formato aila_...). Puede usarla tanto para llamadas REST como para conexiones MCP. Créela desde API e Integraciones.
¿Cuál es el límite de peticiones?
60 peticiones por minuto por clave API. Los headers de respuesta (X-RateLimit-Remaining) le indican su consumo en tiempo real.
¿Puedo lanzar auditorías vía la API?
Sí, el endpoint POST /api/v1/audits/launch permite lanzar auditorías programáticamente. Puede estimar el coste en créditos previamente y seguir el progreso de la auditoría.
¿Existe un SDK oficial?
Todavía no, pero el tutorial de API REST proporciona ejemplos completos en Python, JavaScript y PHP que puede usar como base. Un SDK oficial está en desarrollo.
Conclusión
La API REST de AILabsAudit es la clave para pasar del uso manual a la automatización completa de sus auditorías de visibilidad IA. Ya sea que quiera programar auditorías recurrentes, integrar puntuaciones en su dashboard o crear alertas personalizadas, la API le da las herramientas para hacerlo.
¿Listo para automatizar?
