Como inserir respostas de outro sistema via API?

Entenda como inserir respostas coletadas fora da Amplifique.me diretamente na plataforma via API — útil para sistemas legados, pesquisas presenciais e integrações customizadas.

Visão geral

Se você coleta respostas de pesquisa em um sistema próprio — um app interno, um totem presencial, um sistema legado ou qualquer outra fonte externa — é possível inserir essas respostas diretamente na Amplifique.me via API, fazendo com que apareçam nos relatórios junto com as demais respostas da pesquisa.

Atualmente não existe uma API específica para inserção de respostas. O método utilizado é via API do InApp Legado, que permite registrar respostas originadas de sistemas externos. Uma API dedicada para esse fim está prevista para versões futuras da plataforma.

Quando usar

Você tem um totem ou tablet de coleta presencial e quer que as respostas apareçam na Amplifique.me
Seu sistema possui uma pesquisa própria e você quer consolidar os dados na plataforma
Você está migrando de outro sistema e quer inserir respostas históricas via API (além do importador manual)
Você tem um sistema legado que coleta NPS ou CSAT e precisa enviar os dados para a Amplifique.me

Para importações pontuais de histórico, o importador de respostas da plataforma pode ser mais simples do que uma integração via API. Avalie qual faz mais sentido para o seu volume e frequência de envio.

Como funciona

A inserção é feita em 2 chamadas obrigatórias à API, na seguinte ordem:

Chamada 1 — Buscar Pesquisa

Antes de inserir uma resposta, seu sistema precisa verificar se existe uma pesquisa elegível para aquele contato. Essa chamada retorna:

eligible — se o contato é elegível para responder
complementSurvey — se é apenas para complementar (contato já respondeu mas não deixou comentário)
survey — o objeto completo da pesquisa com as perguntas
surveyAnswer — o objeto da pesquisa/resposta, que contém o _id necessário para a próxima chamada

O _id do surveyAnswer retornado nessa chamada é obrigatório para enviar a resposta na Chamada 2. Salve esse valor antes de prosseguir.

Chamada 2 — Enviar Resposta

Com o _id do surveyAnswer em mãos, seu sistema envia as respostas da pesquisa. Os parâmetros obrigatórios são:

id — Id do SurveyAnswer obtido na Chamada 1 (via URI)
isFinalize — se a resposta está completa e a pesquisa deve ser marcada como finalizada
answers — array com as respostas de cada pergunta

Fluxo completo

Contato acessa o sistema externo
        ↓
1. Chamar "Buscar Pesquisa"
   → Verificar se eligible = true
   → Guardar o _id do surveyAnswer
        ↓
2. Contato responde a pesquisa no sistema externo
        ↓
3. Chamar "Enviar Resposta" com o _id e as respostas
   → isFinalize: true (pesquisa completa)
        ↓
Resposta aparece nos relatórios da Amplifique.me

Opcional — Ignorar Pesquisa: se o contato fechar a pesquisa sem responder, chame o endpoint Ignorar Pesquisa passando o _id do surveyAnswer. Isso registra o comportamento corretamente na plataforma em vez de deixar a solicitação em aberto.

Documentação técnica

A referência técnica completa — endpoints, parâmetros, exemplos de request e response — está disponível no Apiary:

Documentação da API — Apiary

Referência técnica completa dos endpoints de Buscar Pesquisa, Enviar Resposta e Ignorar Pesquisa.

Perguntas frequentes

Sim. Respostas inseridas via API são contabilizadas no saldo da conta, da mesma forma que respostas recebidas organicamente ou importadas pelo importador manual.

O importador é indicado para cargas pontuais e históricas — você sobe um arquivo CSV manualmente. A API é indicada para inserção contínua e automatizada, quando o seu sistema precisa enviar respostas em tempo real ou em lote de forma programática.

A solicitação ficará em aberto na plataforma, sem registro de que foi descartada. Isso pode afetar métricas de taxa de resposta. Recomenda-se sempre chamar o endpoint de Ignorar Pesquisa no evento de fechamento.

Aparecem identificadas como InApp ou Legado, dependendo de como a integração foi configurada. Não é possível alterar o canal de origem após a inserção.

Sim. A integração via API requer desenvolvimento no lado do seu sistema. Compartilhe a documentação técnica do Apiary com o time responsável.

Alternativa sem API

Se você não tem um time técnico disponível, o importador de respostas da plataforma permite subir respostas históricas via planilha CSV sem nenhum desenvolvimento.

Como importar respostas antigas de pesquisas?

Importe respostas de planilhas ou outros sistemas sem precisar de API.

Was this page helpful?