API para integraciones

Conectar una integración con clave y alcances de lectura.

Para qué sirve

Consultar datos autorizados fuera de la interfaz de UXTap.

Cuándo usarlo

Para llevar estudios y resultados a una integración propia.

Antes de empezar

• Permiso de administrador y autenticación requerida
• Almacén seguro de secretos en el servidor

Ejemplo

Consultar estudios con read:studies y seguir el cursor de la siguiente página.

Paso a paso

1. Abrir API para integraciones. En Configuración, abre API para integraciones. Lee el contrato OpenAPI para elegir datos y filtros necesarios. /openapi.json.

1. Crear clave mínima. Usa Nueva clave, asigna nombre, alcances y vigencia. Confirma contraseña cuando se solicite; sigue la creación de contraseña por correo si tu cuenta lo requiere. read:studies · read:results · read:sessions solo si hace falta.

1. Guardar y consultar. Guarda en el servidor la clave mostrada una vez. Envía Authorization: Bearer en consultas a /api/v1 y sigue el cursor hasta terminar las páginas. Sin clave en navegador · Paginación por cursor.

1. Supervisar uso. Mira el consumo diario en la tarjeta y trata 429 según retry-after. Revoca la clave si ya no hace falta y actualiza la integración tras rotarla. Alcance insuficiente · Caducidad · Límite.

Cómo leer el resultado

• Clave con vigencia y alcances definidos
• Consultas de lectura y consumo supervisable

Cuidados y límites

• La API es de solo lectura y no usa cookies ni claves en la URL.
• read:sessions puede incluir texto de respuestas; concédelo solo si es necesario.
• Cambiar contraseña o cerrar todas las sesiones puede revocar claves.

Continuar en la guía interactiva

Leer estudios mediante la API

Guías relacionadas

• Contrato OpenAPI
• Configurar consentimiento y cuidar los datos
• Gestionar equipo, cuenta y comentarios
• Exportar datos y presentar hallazgos