Integraciones
REST API
Tokens, acceso Bearer, ejemplo de solicitud y enlaces a la referencia OpenAPI.
Secciones de la documentación
La API REST está disponible en /api/v1 y es adecuada para scripts, servicios internos, CI,
descargas y otra automatización del lado del servidor.
Para los endpoints protegidos se necesita un token de API personal. La solicitud se ejecuta en nombre del usuario que emitió el token y pasa las mismas comprobaciones de roles y permisos.
Autorización
Transmite el token en el encabezado HTTP:
Authorization: Bearer <token>
Cómo emitir, almacenar y revocar tokens se describe en el artículo Tokens de API.
Ejemplo de solicitud
curl -sS "$TEALBAND_BASE_URL/api/v1/{org}/surveys" \
-H "Accept: application/json" \
-H "Authorization: Bearer $TEALBAND_API_TOKEN"
Sustituye {org} por el ID de la organización. Los parámetros concretos de cada endpoint, el formato de respuesta y los códigos de error se describen en la especificación completa.
Documentación completa
- Referencia OpenAPI — documentación interactiva de endpoints, parámetros y esquemas de respuesta.
- OpenAPI JSON — esquema legible por máquina para generadores de clientes, Postman, Insomnia y verificación de contratos.