API para integrações
Leia estudos, resultados e respostas de fora do UXTap com chaves só de leitura.
2 minutos de leitura
Nesta página
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
Exemplo
Consultar estudos com read:studies e seguir o cursor da próxima página.
Passo a passo
- Abrir API para integrações. Abra Configurações e encontre API para integrações. Clique em Contrato OpenAPI para conferir rotas, filtros e paginação de leitura. Para listar estudos, localize GET /api/v1/studies; confirme quais dados a integração precisa antes de criar a chave. /openapi.json.
- Criar chave mínima. Clique em Nova chave. Digite um nome, como Painel de pesquisa, selecione os escopos necessários e a Validade; para listar estudos, mantenha read:studies. Clique em Continuar, confirme Senha atual e Criar chave. Se precisar definir senha, siga a orientação por e-mail exibida. read:studies · read:results · read:sessions somente se necessário.
- Guardar e consultar. Clique em Copiar chave antes de Concluído e guarde-a no servidor da integração. Faça GET /api/v1/studies enviando Authorization: Bearer com essa chave. Confira a resposta autorizada e siga o cursor conforme o contrato; a chave não deve entrar na URL nem no código público do navegador. Sem chave no navegador · Paginação por cursor.
- Acompanhar uso. Volte a API para integrações e confira estado, validade e Último uso da chave; veja o consumo diário quando exibido. Se a integração for encerrada, clique em Revogar, confirme a senha e confira Revogada. A integração deve tratar 429 respeitando retry-after. Escopo insuficiente · Expiração · Limite.
Como ler o resultado
- Chave com validade e escopos definidos
- Consultas de leitura e consumo acompanhável
Cuidados e limites
- 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.
Continue no guia interativo
Guias relacionados
Isso ajudou?
Ficou faltando alguma coisa? Escreva para contato@paineltap.com.br.