Configurações de Desenvolvedor

A página Configurações de Desenvolvedor é onde você gerencia o acesso programático à sua conta QuestionPro. A API do QuestionPro é uma forma de conectar aplicações externas ao QuestionPro.

• API: Gerencie sua chave de API e revise um registro das chamadas de API feitas com ela.

• Faça login na sua conta QuestionPro.
• Clique no ícone do seu perfil e vá para Minha Conta.
• Clique na guia Configurações de Desenvolvedor.
• Na guia API, você poderá acessar sua chave de API do QuestionPro.

A API do QuestionPro permite que você conecte sua conta QuestionPro a outras aplicações e scripts. Você pode usá-la para recuperar pesquisas e respostas, gerenciar usuários e automatizar tarefas sem fazer login na plataforma. Cada solicitação de API é autenticada com uma chave de API que é exclusiva para sua conta de usuário.

A guia API é onde você habilita ou desabilita o acesso à API, gerencia sua chave de API e revisa um registro de cada chamada de API feita com sua chave.

Uma chave de API é uma string única que o identifica quando sua aplicação chama a API do QuestionPro. Cada chave pertence a um usuário individual do QuestionPro e apenas uma chave é permitida por usuário.

Use o interruptor Status no topo da guia de API.

• Ativo: Solicitações de API feitas com sua chave são aceitas.
• Inativo: Solicitações de API feitas com sua chave não são processadas. Sua chave não é excluída, então você pode voltar a Ativo a qualquer momento.

Para mudar o status:

• Vá para Minha Conta >> Configurações de Desenvolvedor >> API.
• Na seção Status, clique em Ativo ou Inativo.

Por segurança, sua chave de API é mascarada por padrão.

• Clique no ícone de olho no campo da chave de API para mostrar ou ocultar a chave.
• Clique no ícone de copiar para copiar a chave para sua área de transferência.

Se sua chave foi exposta ou você deseja rotacioná-la como uma prática de segurança, pode gerar uma nova.

• Vá para Minha Conta >> Configurações de Desenvolvedor >> API.
• Clique em Regenerar chave de API.
• Confirme quando solicitado.
• Copie sua nova chave e atualize-a em todas as aplicações ou scripts que a utilizarem.

A seção Logs da guia da API lista as chamadas de API feitas com sua chave. Use-a para auditar atividades, confirmar se uma integração está funcionando e solucionar erros. Total de chamadas de API na parte superior da seção mostra o número de chamadas no intervalo de datas selecionado.

A tabela de logs inclui as seguintes colunas:

• ID: ID único da chamada de API. Clique no ID para ver os detalhes dessa chamada.
• Timestamp: Data e hora em que a chamada foi feita.
• Endereço IP: Endereço IP de onde a solicitação veio.
• API URL: O endpoint que foi chamado, por exemplo https://api.questionpro.com/a/api/v2/surveys/{surveyID}.
• Status da Resposta: O código de status HTTP retornado para a chamada.

Para uma lista de códigos de resposta e erro e o que eles significam, consulte a seção Códigos de Erro da documentação da API do QuestionPro.

Digite uma URL de API completa ou parcial ou um ID de log na caixa Pesquisar por URL de API ou ID de log. A tabela será filtrada à medida que você digita.

• Clique no seletor de intervalo de datas, que mostra os últimos 30 dias por padrão.
• Escolha uma data de início e uma data de término.
• A tabela de logs e a contagem de Total de chamadas de API serão atualizadas para mostrar apenas chamadas nesse intervalo.

• Defina o intervalo de datas que deseja exportar.
• Clique em Exportar Logs de API.

Encontre a chamada na tabela Logs e verifique seu Status da Resposta. Qualquer status diferente de 2xx significa que a solicitação não foi concluída com sucesso. Clique no ID da chamada para ver mais detalhes e use a caixa de pesquisa para encontrar um endpoint específico ou ID da pesquisa.

Verifique essas causas comuns:

• O status da API está definido como Inativo.
• A chave da API foi regenerada e a integração ainda está usando a chave antiga.
• A pesquisa ou ID do usuário solicitado não existe ou não está disponível para você (404).

• Nunca compartilhe sua chave publicamente ou inclua-a em repositórios de código-fonte.
• Armazene-a em variáveis de ambiente ou em um gerenciador de segredos.
• Regere-a periodicamente e imediatamente se suspeitar que foi exposta.
• Revise os logs regularmente em busca de endereços IP desconhecidos ou endpoints inesperados.
• Defina o status como Inativo quando não estiver usando integrações de API.