A maioria das pessoas preenche formulários num navegador. Mas os programadores criam formulários dentro de aplicações personalizadas, apps móveis, sistemas embebidos e ferramentas internas. Estes formulários não usam o criador de formulários de arrastar e largar. Usam APIs para enviar os dados diretamente para a tua plataforma de formulários.
Este artigo explica como funcionam as APIs de formulários, quando precisas delas e o que procurar numa plataforma de formulários com um acesso robusto por API.
O que é uma API de formulários e porque a usam os programadores
Uma API de formulários é uma forma de os programadores enviarem os dados de um formulário de forma programática, em vez de usarem um formulário no navegador. Em vez de alguém clicar num botão "enviar" de um formulário web, o programador escreve código que envia os dados diretamente para o sistema de formulários.
Quando farias isto?
Criar uma aplicação personalizada: estás a criar a tua própria app e queres recolher os dados do formulário usando a tua ferramenta de formulários como backend. O teu código chama a API do formulário para enviar.
Envio de formulários numa app móvel: tens uma app móvel com um formulário. Quando os utilizadores enviam, o código da app chama a API do formulário.
Integrar dados de várias fontes: estás a recolher dados de vários sistemas e queres que tudo vá para uma só plataforma de formulários. O teu código de integração usa a API do formulário.
Operações em lote: tens milhares de registos para importar. Em vez de os introduzir à mão, o teu código usa a API do formulário para os enviar de forma programática.
Como funcionam as APIs de formulários (sem precisares de perceber de código)
Uma API de formulários funciona assim: a tua aplicação tem dados. Quer enviá-los para a plataforma de formulários. Faz uma chamada à API (pensa nela como uma mensagem) que diz "aqui estão alguns dados, por favor guarda-os". A plataforma de formulários recebe-os, valida-os e guarda-os exatamente como faria se alguém tivesse preenchido um formulário web e clicado em enviar.
A plataforma de formulários devolve uma resposta a confirmar que o envio foi recebido e guardado.
Do ponto de vista da plataforma de formulários, os dados de um envio por API são idênticos aos de um envio por formulário web. Ambos são tratados por igual.
Autenticação e segurança da API
Quando o teu código chama uma API de formulários, tem de provar que está autorizado. Isto faz-se através da autenticação, normalmente uma chave de API.
Uma chave de API é como uma palavra-passe da tua aplicação. Manténs em segredo. Quando o teu código quer enviar dados, inclui a chave de API. A plataforma de formulários verifica a chave e diz "sim, esta aplicação está autorizada".
Nunca publiques a tua chave de API em código público nem a partilhes. Se alguém ficar com a tua chave, pode enviar dados de formulário em teu nome (o que pode ser um problema se usas os envios dos formulários para decisões críticas do negócio).
Limite de pedidos: quantas chamadas à API são permitidas
A maioria das plataformas de formulários limita quantas chamadas à API podes fazer. Isto evita abusos e protege o sistema.
Um limite típico pode ser "1.000 chamadas à API por hora por chave de API". Se a tua aplicação fizer mais chamadas do que o limite, as chamadas seguintes são rejeitadas até a hora reiniciar.
Ao escolher uma plataforma de formulários, verifica os limites de pedidos da API. Se precisas de fazer 10.000 envios por hora, um limite de 1.000 chamadas por hora não te serve. Pergunta à plataforma por limites mais altos ou opções de escala.
Respostas da API e tratamento de erros
Quando o teu código chama a API do formulário, recebe uma resposta. Essa resposta diz-te se o envio teve sucesso ou falhou.
Resposta de sucesso: HTTP 200 ou 201. O envio foi recebido e guardado. O teu código pode continuar.
Resposta de erro: HTTP 400, 401, 500, etc. Algo correu mal. O teu código deve tratar o erro (tentar de novo, registá-lo, avisar alguém).
Boas mensagens de erro da API dizem-te o que correu mal. "Missing required field: email" ajuda. "Error" sem mais detalhes não ajuda.
Envios em lote através da API
Às vezes tens vários envios para fazer de uma vez. Algumas APIs suportam operações em lote: envias 100 envios numa só chamada à API em vez de fazeres 100 chamadas separadas.
Os envios em lote são mais eficientes. Reduzem o número de chamadas à API e concluem-se mais depressa.
Verifica se a API da tua plataforma de formulários suporta envios em lote. Se precisas de importar grandes volumes de dados, esta funcionalidade conta.
Notificações por webhook do ponto de vista da API
Quando os dados chegam por API, podes querer notificações ou ações de seguimento. Algumas plataformas de formulários enviam notificações por webhook para os envios por API, tal como fazem para os envios por formulário web.
Isto significa que, se o teu código envia por API, os teus sistemas a jusante (CRM, email, etc.) continuam a ser notificados automaticamente.
Documentação da API e experiência do programador
Uma boa API de formulários tem documentação excelente. Explica como autenticar, que endpoint chamar, que formato de dados usar, que erros podes receber e inclui exemplos de código.
Uma documentação de API fraca torna a vida do programador miserável. Se estás a escolher uma plataforma de formulários e precisas de acesso por API, lê primeiro a documentação da API. É clara? Há exemplos? Consegues percebê-la?
Quando usar a API e quando usar formulários web
Usa um formulário web quando: queres que os visitantes preencham um formulário no navegador. Não precisas de código. A interface de arrastar e largar do criador de formulários chega.
Usa uma API quando: és programador e estás a criar uma aplicação personalizada. Precisas de enviar dados de forma programática. Estás a integrar várias fontes de dados. Precisas de personalizar toda a experiência de envio.
Muitas vezes usas as duas. Um website tem formulários web para os visitantes. A tua aplicação interna usa a API para envios programáticos.
Como a WEMASY suporta APIs de formulários
A WEMASY oferece uma API REST que permite aos programadores enviar dados de formulários de forma programática. Autentica com uma chave de API, envia os dados para o endpoint e recebe a confirmação. Os envios por API são tratados de forma idêntica aos envios por formulário web. Disparam automações, sincronizam com os sistemas integrados e aparecem no teu painel WEMASY. Os limites de pedidos e o envio em lote estão disponíveis consoante o teu plano. Consulta a documentação da API na tua conta WEMASY ou vê a página de preços para os detalhes do acesso por API.