API para integrações
Leia estudos, resultados e respostas de fora do UXTap com chaves só de leitura.
1 minuto 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. Em Configurações, abra API para integrações. Leia o contrato OpenAPI para escolher os dados e filtros necessários. /openapi.json.
- Criar chave mínima. Use Nova chave, dê nome, selecione escopos e validade. Confirme a senha quando solicitada; siga a criação de senha por e-mail se sua conta precisar. read:studies · read:results · read:sessions somente se necessário.
- Guardar e consultar. Guarde a chave exibida uma vez no servidor. Envie Authorization: Bearer nas consultas a /api/v1 e siga o cursor até não haver próxima página. Sem chave no navegador · Paginação por cursor.
- Acompanhar uso. Veja consumo diário no card e trate 429 conforme retry-after. Revogue a chave se não for mais necessária e atualize a integração após rotação. 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@uxtap.app.