Central de ajuda
Ler estudos pela API
Conectar uma integração com chave e escopos de leitura.
Para que serve
Consultar dados autorizados fora da interface do UXTap.
Quando usar
Para enviar estudos e resultados a uma integração própria.
Antes de começar
- Permissão de administrador e autenticação exigida
- Cofre de segredos no servidor
Veja como fazer
Telas reais com dados demonstrativos
1 / 4
01
Abrir API para integrações
Em Configurações, abra API para integrações. Leia o contrato OpenAPI para escolher os dados e filtros necessários.
- /openapi.json
Um exemplo para experimentar
Consultar estudos com read:studies e seguir o cursor da próxima página.
O que aparece nos resultados
- Chave com validade e escopos definidos
- Consultas de leitura e consumo acompanhável
Evite estas confusões
- A API é somente leitura e não usa cookie ou chave na URL.
- read:sessions pode incluir texto de respostas; conceda apenas se necessário.
- Trocar senha ou sair de todos os dispositivos pode revogar as chaves.