Marketing
Typeform no seu produto e nos seus agentes de IA, por uma API
O toolkit do Typeform cobre workspaces, formulários (listar, consultar, criar, substituir a definição inteira), respostas (listar, buscar por resposta, tag, hidden field ou horário) e temas. O cliente conecta com uma chave de API ou OAuth, o Connect guarda as credenciais e registra cada execução, para o seu produto ou agente de IA montar formulários e coletar respostas sem uma integração própria.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/typeform_create_workspace/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"name": "<name>"
}
}Como funciona
Do cliente conectado à primeira chamada no Typeform.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do Typeform. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o Typeform.
Gerar um formulário a partir de um prompt
Um agente de IA transforma um briefing em campos e lógica, cria o formulário com Create form e devolve o link público de _links.display.
Trazer respostas para o seu produto
Leia as respostas de um formulário da mais nova para a mais antiga, ou busque por um valor de resposta ou hidden field, e sincronize com seu CRM ou painel.
Formulários modelo por cliente
Leia um formulário com Get form, altere o que precisar e envie a definição completa de volta com Update form, mantendo os ids dos campos para que as respostas continuem ligadas.
Tools
9 tools do Typeform
- Listar workspacesGETLista os workspaces que a conta alcança, entre suas organizações, com id, name, self.href e o número de formulários. Pagine com page até chegar ao page_count da resposta.
- Criar workspacePOSTCria um workspace na organização em que o usuário conectado é proprietário e o retorna com id e self.href.
- Listar formuláriosGETLista os formulários da conta, públicos e privados, com id, título, datas e o link público em _links.display. Pagine com page até chegar ao page_count da resposta.
- Consultar formulárioGETRetorna a definição inteira de um formulário: configurações, tema, workspace, hidden fields, telas, lógica e os campos com seus ids e refs. Os ids dos campos são o que as tools de respostas filtram.
- Criar formulárioPOSTCria um formulário em um workspace e o retorna com id, ids dos campos e o link público em _links.display. Imagens em campos e telas já precisam existir na conta.
- Atualizar formulárioPUTSubstitui a definição inteira de um formulário. Leia-o com Get form, altere o que precisar e envie tudo de volta: cada campo mantém seu id, e um campo deixado de fora é apagado junto com suas respostas nas respostas existentes.
- Listar respostasGETLista as respostas de um formulário, da mais nova para a mais antiga, com answers, hidden fields, variáveis, metadados e os horários landed_at e submitted_at. Respostas dos últimos 30 minutos podem não aparecer. O corpo traz total_items; para a próxima página, envie o response_id do último item como before.
- Buscar respostasPOSTBusca as respostas de um formulário por valores de resposta, tags, hidden fields, metadados ou horário de envio, todas as condições juntas. Use em vez de List responses para filtrar por uma resposta. Para a próxima página, envie o response_id do último item como before_response_id.
- Listar temasGETLista os temas da conta, do mais novo para o mais antigo, com id, nome, cores e fonte. Pagine com page até chegar ao page_count da resposta.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/typeform, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
Perguntas sobre o toolkit do Typeform
Preciso implementar a API do Typeform?
Não. O Connect já traz 9 tools do Typeform descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do Typeform?
Pelo modo que o toolkit aceita: Chave de API, OAuth com o app do seu produto. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
