Pular para o conteúdo principal

Enviando um formulário

Neste exemplo, demonstramos como enviar um formulário usando a API OneEntry.

✅ Propósito do cenário:

  • Obter a configuração do formulário da Plataforma OneEntry
  • Coletar dados de entrada do usuário a partir de um formulário de contato.
  • Garantir que os dados estejam corretamente formatados e validados antes do envio.
  • Enviar os dados coletados para a API OneEntry.

✅ O que você precisa:

  • Uma PROJECT_URL e APP_TOKEN válidos para autenticação com a API OneEntry.
  • Um formulário pré-configurado na OneEntry identificado por um marcador (por exemplo, 'contact_us').
  • Campos de formulário pré-configurados.

📌 Importante:

  • Lidar com possíveis erros durante as requisições da API de forma elegante para fornecer feedback aos usuários.
  • Manter a privacidade e segurança dos dados, especialmente ao lidar com informações sensíveis como endereços de e-mail.
  • Manter os campos do formulário e seus marcadores sincronizados com a configuração do backend para evitar incompatibilidades.
  • Estes exemplos não incluem tratamento de erros.
  • Você pode gerenciar erros usando um bloco try-catch ou empregando uma construção como await Promise.catch((error) => error).

Cenário​

1. Importar defineOneEntry do SDK e definir url e token​

Exemplo:

import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Criando um cliente API com a função defineOneEntry()​

Exemplo:

const { Forms, FormData } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Obter formulário com Forms.getFormByMarker()​

Exemplo:

const formData = await Forms.getFormByMarker('contact_us');
Resultado:
{
  "id": 3,
  "attributeSetId": 2,
  "type": "data",
  "localizeInfos": {
    "title": "Entre em contato",
    "titleForSite": "",
    "successMessage": "Mensagem sobre o processamento bem-sucedido dos dados",
    "unsuccessMessage": "Mensagem sobre o processamento malsucedido dos dados",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 5,
  "position": 1,
  "identifier": "contact_us",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "string",
      "marker": "first_name",
      "isLogin": null,
      "isSignUp": null,
      "position": 1,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        }
      },
      "localizeInfos": {
        "title": "Nome"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "email",
      "isLogin": null,
      "isSignUp": null,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        },
        "emailInspectionValidator": true
      },
      "localizeInfos": {
        "title": "Email"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "surname",
      "isLogin": null,
      "isSignUp": null,
      "position": 3,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "stringInspectionValidator": {
          "stringMax": 0,
          "stringMin": 0,
          "stringLength": 0
        }
      },
      "localizeInfos": {
        "title": "Sobrenome"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "list",
      "marker": "topic",
      "isLogin": null,
      "isSignUp": null,
      "position": 4,
      "settings": {},
      "isVisible": true,
      "listTitles": [
        {
          "title": "Artigo",
          "value": "article",
          "extended": {
            "type": null,
            "value": null
          },
          "position": 1
        },
        {
          "title": "Artigo-2",
          "value": "article-2",
          "extended": {
            "type": null,
            "value": null
          },
          "position": 2
        }
      ],
      "validators": {
        "requiredValidator": {
          "strict": true
        }
      },
      "localizeInfos": {
        "title": "Tópico"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "text",
      "marker": "text",
      "isLogin": null,
      "isSignUp": null,
      "position": 5,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Texto"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "spam",
      "marker": "spam",
      "isLogin": null,
      "isSignUp": null,
      "position": 6,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Você não é um robô?"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "button",
      "marker": "send",
      "isLogin": null,
      "isSignUp": null,
      "position": 7,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Enviar"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ],
  "moduleFormConfigs": [
    {
      "id": 2,
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "viewOnlyUserData": false,
      "commentOnlyUserData": false,
      "entityIdentifiers": [
        {
          "id": "services",
          "isNested": false
        }
      ]
    }
  ]
}

4. Obter configurações adicionais para o envio do formulário​

Exemplo:

const moduleFormConfig = formData?.moduleFormConfigs?.[0];

5. Obter dados dos campos do Formulário frontend​

Exemplo:

[
  {
    "marker": "first_name",
    "value": "Firstname"
  },
  {
    "marker": "surname",
    "value": "Surname"
  },
  {
    "marker": "email",
    "value": "your@email.com"
  },
  {
    "marker": "topic",
    "value": [
      "article"
    ]
  },
  {
    "marker": "text",
    "value": [
      {
        "plainValue": "Algum texto"
      }
    ]
  }
]

6. Transformar dados para uso com o Formulário OneEntry​

Exemplo:

const transformedFormData = fieldsData.map((field: any) => {
  const { marker, value } = field;
  const formField = formFields.find(
    (field: { marker: string }) => field.marker === marker,
  );
  const { type } = formField;

  return {
    marker,
    type,
    value,
  }
});
Resultado:
[
  {
    "marker": "first_name",
    "type": "string",
    "value": "Firstname"
  },
  {
    "marker": "surname",
    "type": "string",
    "value": "Surname"
  },
  {
    "marker": "email",
    "type": "string",
    "value": "your@email.com"
  },
  {
    "marker": "topic",
    "type": "list",
    "value": [
      "article"
    ]
  },
  {
    "marker": "text",
    "type": "text",
    "value": [
      {
        "plainValue": "Algum texto"
      }
    ]
  }
]

7. Enviar FormsData com FormData.postFormsData()​

Exemplo:

const formResponse = await FormData.postFormsData({
  formIdentifier: 'contact_us',
  formData: transformedFormData,
  formModuleConfigId: moduleFormConfig?.id || 0,
  moduleEntityIdentifier: moduleFormConfig?.entityIdentifiers?.[0]?.id || '',
  replayTo: null,
  status: 'sent',
});
Resultado:
{
  "formData": {
    "formIdentifier": "contact_us",
    "time": "2025-11-17T12:51:20.172Z",
    "formData": [
      {
        "marker": "first_name",
        "type": "string",
        "value": "Firstname"
      },
      {
        "marker": "surname",
        "type": "string",
        "value": "Surname"
      },
      {
        "marker": "email",
        "type": "string",
        "value": "your@email.com"
      },
      {
        "marker": "topic",
        "type": "list",
        "value": [
          "article"
        ]
      },
      {
        "marker": "text",
        "type": "text",
        "value": [
          {
            "plainValue": "Algum texto"
          }
        ]
      }
    ],
    "entityIdentifier": "services",
    "fingerprint": "UQ_rrofe2",
    "isUserAdmin": false,
    "formModuleId": 2,
    "userIdentifier": null,
    "parentId": null,
    "id": 120
  },
  "actionMessage": "Mensagem sobre o processamento bem-sucedido dos dados"
}

Exemplo final​

// 1. Importar defineOneEntry do SDK e definir PROJECT_URL e APP_TOKEN
import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

// 2. Criando um cliente API 
const { Forms, FormData } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Obter formulário e ordenar campos por posição
const formData = await Forms.getFormByMarker('contact_us');
const formFields = formData?.attributes.slice().sort(
  (a: { position: number }, b: { position: number }) =>
    a.position - b.position,
);

// 4. Isso contém configurações adicionais para o envio do formulário
const moduleFormConfig = formData?.moduleFormConfigs?.[0];

// 5. Obter dados dos campos do Formulário frontend
const fieldsData = [
  {
    marker: 'first_name',
    value: 'Firstname',
  },
  {
    marker: 'surname',
    value: 'Surname',
  },
  {
    marker: 'email',
    value: 'your@email.com',
  },
  {
    marker: 'topic',
    value: [
      'article',
    ],
  },
  {
    marker: 'text',
    value: [
      {
        plainValue: 'Algum texto',
      },
    ],
  },
];

// 6. Transformar dados para uso com o Formulário OneEntry 
const transformedFormData = fieldsData.map((field: any) => {
  const { marker, value } = field;
  const formField = formFields.find(
    (field: { marker: string }) => field.marker === marker,
  );
  const { type } = formField;

  return {
    marker,
    type,
    value,
  };
});

// 7. Enviar FormsData com FormData.postFormsData()
const formResponse = await FormData.postFormsData({
  formIdentifier: 'contact_us',
  formData: transformedFormData,
  formModuleConfigId: moduleFormConfig?.id || 0,
  moduleEntityIdentifier: moduleFormConfig?.entityIdentifiers?.[0]?.id || '',
  replayTo: null,
  status: 'sent',
});
console.log(formResponse);