Formidable API

Guia Completo sobre a API Formidable

A API Formidable é uma ferramenta poderosa, projetada para permitir que desenvolvedores interajam com formulários e dados de forma eficiente. Esta API fornece um conjunto robusto de funcionalidades que permitem a criação, leitura, atualização e exclusão de entradas em formulários, facilitando a automação e a integração com outros serviços.

O que é a API Formidable?

A API Formidable permite que você interaja programaticamente com formulários criados com o plugin Formidable Forms. Com ela, você pode enviar dados do seu formulário para outros sistemas, realizar operações de CRUD e até comunicar-se com APIs externas. Isso é especialmente útil para desenvolvedores que desejam integrar sistemas ou otimizar fluxos de trabalho em ambientes WordPress.

Princípios Básicos da API Formidable

Autenticação

A API utiliza a Autenticação Básica, o que significa que você precisará de uma chave de API para fazer solicitações. A chave é criada quando você ativa o plugin da API Formidable. É sempre recomendado utilizar o SSL (HTTPS) ao fazer requisições, garantindo que seus dados estejam protegidos.

Métodos HTTP

A API oferece suporte a vários métodos HTTP, cada um com seu propósito:

• GET: Usado para recuperar dados. É seguro e não altera o estado da aplicação.
• POST: Usado para criar novas entradas ou enviar dados.
• PUT/PATCH: Usado para atualizar dados existentes. O PATCH permite alterações parciais.
• DELETE: Usado para excluir entradas.

Como Configurar a API Formidable

Passo 1: Instalação do Formidable Forms

Caso ainda não tenha feito, instale e ative a versão premium do Formidable Forms em seu site WordPress. Após ativar o plugin, dirija-se à seção de configurações do Formidable para habilitar a API.

Passo 2: Obtenção da Chave da API

A chave da API pode ser encontrada em Formidable → Configurações Globais → API. Essa chave é essencial para autenticar suas requisições. Caso precise regenerá-la, basta clicar no ícone de atualizar ao lado dela.

Passo 3: Configurando a Ação de Envio de API

Ao configurar um formulário, você pode adicionar uma ação para enviar dados para a API:

1. Vá até as configurações do formulário e selecione “Ações e Notificações”.
2. Adicione uma nova ação “Enviar Dados da API”.
3. Preencha a URL de notificação (endpoint do serviço externo).
4. Insira a chave API no campo de autenticação.
5. Escolha o método de requisição adequado (POST, GET, etc.).

Operações Comuns com a API Formidable

Enviar Dados para Outro Site

Se você deseja enviar dados do formulário para outro site que também possui a API Formidable ativada, siga estas etapas:

1. Faça a configuração na seção “Ações e Notificações” para inserir a URL de notificação.
2. Forneça as informações de autenticação necessárias.
3. Ao enviar uma nova entrada no formulário, os dados serão transferidos automaticamente para o site de destino.

Criar uma Entrada Através do Postman

Quando usar ferramentas como o Postman, a criação de uma nova entrada é simples:

1. Configure um novo pedido do tipo POST.
2. Use a URL yoursite.com/wp-json/frm/v2/entries.
3. No corpo da requisição, você pode inserir dados em formato JSON:
   json
{
"form_id": "860",
"18911": "Hello world"
}
4. Use a autenticação básica com sua chave API.

Roteiros da API Formidable

Roteiro para Entradas

• GET /wp-json/frm/v2/entries: Obtém todas as entradas de formulário.
• POST /wp-json/frm/v2/entries: Cria uma nova entrada.
• PUT/PATCH /wp-json/frm/v2/entries/{id}: Atualiza a entrada especificada.
• DELETE /wp-json/frm/v2/entries/{id}: Remove a entrada especificada.

Roteiros para Formulários e Vistas

• GET /wp-json/frm/v2/forms: Obtém todos os formulários.
• POST /wp-json/frm/v2/forms: Cria um novo formulário.
• GET /wp-json/frm/v2/forms/{id}: Obtém uma única entrada de formulário.

Exemplos Práticos

Enviando Dados a um Serviço Externo

Para enviar dados para um serviço como o Zapier, siga as instruções abaixo:

1. Em Zapier, crie um novo Zap e selecione “Webhooks by Zapier”.
2. Na ação do seu formulário Formidable, adicione o URL fornecido pelo Zapier na seção de URL de notificação.
3. Insira a infraestrutura de mapeamento de dados para corresponder ao que o Zapier espera.

Atualizando uma Entrada

Para atualizar uma entrada específica:

1. Configure uma ação no Formidable para enviar dados a /wp-json/frm/v2/entries/{id}.
2. Coloque os dados que deseja atualizar no corpo da requisição, usando o método PATCH.

Exemplos de Implementação

A API Formidable também permite interações complexas, como enviar dados para um campo de um formulário repetidor ou integrar com outras APIs e serviços. Aqui estão alguns exemplos:

Enviando Dados de um Campo de Endereço

Se você precisar enviar dados de um campo de endereço de uma entrada para outra:

json
{
"727": {
"line1": "[fieldline1]",
"city": "[fieldcity]",
"state": "[fieldstate]"
}
}

Integração com Aplicativos de Terceiros

Ao se conectar a APIs externas, como a API de Tradução, você pode registrar as informações e os resultados dentro do seu sistema, facilitando a gestão de dados.

Conclusão

A Formidable API é uma poderosa ferramenta que amplia as capacidades dos formulários WordPress, permitindo a integração e a automação com outros sistemas. Com seu uso, desenvolvedores podem criar soluções dinâmicas e interativas que melhoram a usabilidade e a eficácia dos workflows. Integrar e utilizar essa API abre um leque de possibilidades para optimizar os processos e oferecer uma experiência de usuário diferenciada.