API: interface de programação de aplicações
Glossário Atualizado: 11 nov 2026 Tempo de leitura ≈ 1 min
- Tema
- Ferramentas e configurações de pesquisa
O que é uma API
Uma API (interface de programação de aplicações) é um conjunto de regras que permite que um programa peça dados ou ações a outro. Em vez de uma pessoa clicar em telas, o seu aplicativo envia uma requisição e recebe uma resposta estruturada, quase sempre em JSON.
Uma API web funciona sobre HTTP. O cliente chama um endereço (um endpoint) com um método como GET ou POST e uma chave que prova quem ele é. O servidor confere a chave e devolve os dados, ou um código de erro como 401 quando a chave falta ou está errada.
Como funciona no SurveyNinja
- A API REST está disponível em todos os planos, inclusive no Grátis, e devolve JSON.
- Você cria a chave no menu do perfil, em API / MCP, e a envia no cabeçalho Authorization de cada requisição. Uma conta pode ter até 5 chaves.
- Com a API você lista pesquisas, lê respostas, baixa as respostas em CSV ou Excel e gerencia variáveis ocultas e webhooks.
- Cada requisição devolve até 100 respostas. Para o restante, use limit e offset.
- A mesma chave conecta assistentes de IA como Claude ou Cursor via MCP.
O passo a passo está no artigo de ajuda API, e todos os endpoints estão na referência da API. Para assistentes de IA, veja Conectar assistentes de IA (MCP).
API ou webhook
Com uma API, o seu sistema pede os dados quando precisa. Um webhook funciona ao contrário: o SurveyNinja envia cada resposta concluída para o seu endereço assim que ela chega. Use a API para sincronizações e relatórios periódicos, e um webhook quando cada resposta precisa chegar na hora ao seu CRM.
Dicas
- Guarde a chave como uma senha. As requisições feitas com ela têm o mesmo acesso que o dono do espaço de trabalho, e ela aparece uma única vez.
- Para cortar o acesso de um aplicativo, exclua a chave dele. Requisições com uma chave excluída recebem o código 401.
Atualizado: 11 nov 2026 Publicado: 5 fev 2026
Pesquisa pós-compra no WooCommerce: 7 perguntas, quando fazer e o que fazer depois
Mike Taylor