1.1. Introdução
A API do Simpoll conecta o seu site a qualquer pesquisa do Simpoll de várias formas. A principal função dela é enviar os resultados da pesquisa para o seu site, para que você os processe.
Com a API você pode:
- associar os respondentes aos visitantes do seu site;
- saber quais visitantes responderam à pesquisa;
- saber como um visitante se saiu em um quiz (passou ou não);
- obter as respostas que um visitante deu na pesquisa.
1.2. Como funciona
O fluxo é assim:
- Ao incorporar uma pesquisa no seu site, você pode passar para ela quaisquer parâmetros extras (por exemplo, o ID do usuário);
- O usuário responde à pesquisa dentro do quadro do Simpoll;
- Quando a pesquisa termina, o Simpoll chama a URL de resultados do seu site e devolve os parâmetros que recebeu de você (se houver);
- Junto com os seus parâmetros, o Simpoll envia os resultados da pesquisa para a URL de resultados.
Assim, além de entregar resultados, uma pesquisa pode funcionar como “proxy” para quaisquer dados seus.
Os parâmetros podem ser enviados para a URL de resultados de uma de três formas:
Método POST
Os dados são enviados em segundo plano, sem que o usuário veja e sem passar pelo navegador dele. A requisição é enviada quando o usuário clica em “Enviar” na última página da pesquisa.
Método GET
O navegador do usuário é redirecionado da última página da pesquisa para a URL de resultados, com os dados adicionados como parâmetros GET. Nesse modo, a configuração “Redirecionar após a pesquisa” é ignorada.
Chamada de uma função JavaScript na sua página
Seus parâmetros e os resultados da pesquisa são passados para uma função JavaScript da página onde a pesquisa está incorporada. A função tem um nome fixo e um argumento: um objeto com os seus parâmetros e os resultados da pesquisa.
Esse método funciona em todos os navegadores modernos.
1.3. Segurança na transferência de dados
A API do Simpoll pode assinar os dados que recebe e envia. As assinaturas são opcionais, mas garantem que ninguém altere os dados no caminho.