API para integraciones
Leia estudos, resultados e respostas de fora do UXTap com chaves só de leitura.
2 minutos de lectura
En esta página
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
- Abrir API para integraciones. Abre Configuración y busca API para integraciones. Pulsa Contrato OpenAPI para revisar rutas, filtros y paginación de lectura. Para listar estudios, localiza GET /api/v1/studies y confirma los datos necesarios antes de crear la clave. /openapi.json.
- Crear clave mínima. Pulsa Nueva clave. Escribe un nombre, como Panel de investigación, elige los alcances necesarios y la vigencia; para listar estudios, conserva read:studies. Pulsa Continuar, confirma Contraseña actual y Crear clave. Si necesitas definir contraseña, sigue la orientación por correo mostrada. read:studies · read:results · read:sessions solo si hace falta.
- Guardar y consultar. Pulsa Copiar clave antes de Finalizado y guárdala en el servidor de integración. Haz GET /api/v1/studies con Authorization: Bearer y esa clave. Comprueba la respuesta autorizada y sigue el cursor según el contrato; no pongas la clave en la URL ni en código público del navegador. Sin clave en navegador · Paginación por cursor.
- Supervisar uso. Vuelve a API para integraciones y revisa estado, vigencia y Último uso; consulta el consumo diario si aparece. Si finaliza la integración, pulsa Revocar, confirma la contraseña y comprueba Revocada. La integración debe tratar 429 respetando retry-after. 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
Guías relacionadas
¿Te sirvió?
¿Te faltó algo? Escribe a contato@paineltap.com.br.