Integração com Typeform
Criação e envio automáticos de diplomas e certificados com base nos dados do Typeform após a conclusão de uma pesquisa. Todas as informações coletadas na pesquisa podem ser integradas diretamente ao diploma ou certificado.
Adicionando Variáveis
Acesse no Typeform a pesquisa desejada, localize a pergunta cuja resposta deverá ser inserida no documento e copie o ID dela a partir da URL (o texto após "block=").
ID da pergunta no Typeform
Depois, no documento adicione um campo de texto e insira a variável correspondente ao ID copiado (adicione o sinal de porcentagem (%) antes do ID, sem espaço). A resposta dessa pergunta será inserida automaticamente no local desse campo. Você pode ajustar a formatação do texto para atender às suas necessidades estéticas.
Documento no DiMaker com o ID da pergunta
Você pode adicionar múltiplos blocos de texto e variáveis. O DiMaker consegue utilizar dados dos seguintes campos do Typeform: Texto Curto, Texto Longo, Número de Telefone, Email, Website, Número, Data, Ranking, Escala de Opções, Avaliação, Matriz, Escolha Múltipla, Sim/Não.
IDs Descritivos
Para trabalhar melhor com variáveis, publique sua pesquisa no Typeform e, nas configurações, clique em "Block references" para criar IDs mais descritivos (por exemplo, last_name ou first_name).
Block references no Typeform
Assim, no documento do DiMaker você poderá utilizar essas variáveis com o respectivo ID precedido pelo símbolo de porcentagem (%), por exemplo, %last_name.
Documento no DiMaker com o ID da pergunta
Criando um Webhook
Para permitir que o Typeform envie os dados após a conclusão de uma pesquisa, será necessário adicionar um webhook. No questionário, clique em "Connect" - "Webhooks" e, depois, em "Add a webhook".
Adicionando webhook no Typeform
Na janela de criação do webhook, é fundamental preencher corretamente o Endpoint (ponto de acesso).
https://dimaker.app/api/v1/typeform-create/
Além disso, é necessário configurar as seguintes variáveis:
-
secure*
Token (string de 36 caracteres) disponível na página "Tokens API".
-
doc_id*
ID do documento (string de 36 caracteres) que será utilizado para criar o arquivo. O ID pode ser encontrado na URL quando o documento estiver aberto. Certifique-se de que o documento não está na lixeira, mas ele pode estar em qualquer pasta de Documentos.
-
mail_id
ID do modelo de email (string de 36 caracteres) que será utilizado para enviar o arquivo por email. O ID pode ser encontrado na URL quando o modelo estiver aberto. Caso a variável não seja fornecida, o email não será enviado.
-
email_send
Quando enviar o email com o arquivo. Pode receber os seguintes valores:
onfinish - Enviar todos os emails após a geração dos arquivos (padrão)
oncreate - Enviar os emails imediatamente após a criação do arquivo. Ao gerar somente um arquivo, onfinish e oncreate são iguais.
timeout - Enviar emails após um intervalo específico. Nesse caso, deve-se também configurar dois parâmetros adicionais:
email_timeout_value - valor numérico que representa o intervalo para envio dos emails
email_timeout_unit - unidade do intervalo. Pode ser "m" (minutos), "h" (horas) ou "d" (dias).
Alternativamente, para um horário exato, use o formato unix time em email_timeout_timestamp. Caso ambos sejam fornecidos, o email_timeout_timestamp terá prioridade. -
folder_id
ID da pasta no Disco (string de 36 caracteres) onde os arquivos serão salvos. Caso a pasta não exista, ela será criada automaticamente na geração do primeiro arquivo.
-
page_id
Número da página (valor numérico ou string) caso o documento possua múltiplas páginas. Pode-se especificar um número (primeira página é 0) ou uma lista de números (separados por vírgulas) para gerar o arquivo.
Para inserir informações como a data atual, número aleatório ou outros dados, utilize as funções.
Montando o Endpoint
Agora você pode criar o endereço do endpoint. É preferível fazer isso em um editor de texto e, depois, copiar no campo Endpoint da janela de configuração do webhook. Um exemplo de URL final poderia ser (cores para facilitar visualização):
Entenda os elementos da string:
- https://dimaker.app/api/v1/typeform-create/? - endereço base do request
- doc_id=b75b01cf-c732-49c6-80a0-77dd051a8299 - ID do documento
- folder_id=5a390b28-9845-4c01-b94a-7d252b115e2e - ID da pasta no Disco
- mail_id=fb5eff48-4c08-4df7-a9e6-29e17896317c - ID do modelo de email
- secure=8453bc41-с34у-4ead-80e8-c4e76175a11b - Token API
Entre as variáveis, use o caractere &. Não utilize espaços. Certifique-se de preencher a string corretamente com seus dados, sem omitir qualquer caractere. Após inserir o URL, salve o webhook.
Pronto! Agora é só testar se tudo está funcionando. Para isso, preencha sua pesquisa no Typeform. Se tudo foi configurado corretamente, um arquivo de diploma ou certificado será gerado na pasta do Disco especificada. Caso tenha configurado o mail_id, o arquivo será enviado por email. Se o arquivo não aparecer, verifique o histórico de webhooks no Typeform, em "View deliveries", onde a aba "Response" indicará o motivo.