Aller au contenu principal

Soumettre un formulaire

✅ Objectif du scénario :

  • Obtenir la configuration du formulaire depuis OneEntry CMS
  • Collecter les données saisies par l'utilisateur à partir d'un formulaire de contact.
  • S'assurer que les données sont correctement formatées et validées avant la soumission.
  • Soumettre les données collectées à une API OneEntry.

✅ Ce dont vous avez besoin :

  • Une PROJECT_URL et un APP_TOKEN valides pour l'authentification avec l'API OneEntry.
  • Un formulaire préconfiguré dans OneEntry identifié par un marqueur (par exemple, 'contact_us').
  • Des champs de formulaire préconfigurés.

📌 Important :

  • Gérez les erreurs potentielles lors des requêtes API de manière élégante pour fournir un retour aux utilisateurs.
  • Maintenez la confidentialité et la sécurité des données, en particulier lors de la gestion d'informations sensibles comme les adresses e-mail.
  • Gardez les champs de formulaire et leurs marqueurs synchronisés avec la configuration backend pour éviter les incohérences.
  • Nous ne gérons pas les erreurs dans ces exemples.
  • Vous pouvez gérer les erreurs dans un trycatch ou dans une construction comme "await Promise.catch((error) => error)"

Scénario​

1. Importer oneEntry et définir l'url et le token​

Exemple :

import { defineOneEntry } from 'oneentry';

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

2. Créer un client API avec la fonction defineOneEntry()​

Exemple :

const { AuthProvider, Orders, Payments, Forms } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Obtenir le formulaire avec Forms.getFormByMarker()​

Exemple :

const formData = await Forms.getFormByMarker('contact_us');
Résultat :
[
  {
    "type": "string",
    "marker": "first_name",
    "isLogin": null,
    "isSignUp": null,
    "position": 1,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {
      "requiredValidator": {
        "strict": true
      }
    },
    "localizeInfos": {
      "title": "Prénom"
    },
    "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": "Nom de famille"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "list",
    "marker": "topic",
    "isLogin": null,
    "isSignUp": null,
    "position": 4,
    "settings": {},
    "isVisible": true,
    "listTitles": [
      {
        "title": "Article",
        "value": "article",
        "extended": {
          "type": null,
          "value": null
        },
        "position": 1
      },
      {
        "title": "Article-2",
        "value": "article-2",
        "extended": {
          "type": null,
          "value": null
        },
        "position": 2
      }
    ],
    "validators": {
      "requiredValidator": {
        "strict": true
      }
    },
    "localizeInfos": {
      "title": "Sujet"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "text",
    "marker": "text",
    "isLogin": null,
    "isSignUp": null,
    "position": 5,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {},
    "localizeInfos": {
      "title": "Texte"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "spam",
    "marker": "spam",
    "isLogin": null,
    "isSignUp": null,
    "position": 6,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {},
    "localizeInfos": {
      "title": "Vous n'êtes pas un robot ?"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "button",
    "marker": "send",
    "isLogin": null,
    "isSignUp": null,
    "position": 7,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {},
    "localizeInfos": {
      "title": "Envoyer"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  }
]

4. Obtenir les données des champs depuis le formulaire frontend​

Exemple :

[
  {
    "marker": "first_name",
    "value": "Prénom"
  },
  {
    "marker": "surname",
    "value": "Nom de famille"
  },
  {
    "marker": "email",
    "value": "votre@email.com"
  },
  {
    "marker": "topic",
    "value": [
      {
        "title": "Article",
        "value": "article"
      }
    ]
  },
  {
    "marker": "text",
    "value": "Du texte"
  }
]

5. Transformer les données pour une utilisation avec le formulaire OneEntry​

Exemple :

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

  switch (type) {
    case 'text':
      return {
        marker,
        type: 'text',
        value: [
          {
            htmlValue: value,
            plainValue: value,
          },
        ],
      };
    default:
      return {
        marker,
        type,
        value,
      };
  }
});
Résultat :
[
  {
    "marker": "first_name",
    "type": "string",
    "value": "Prénom"
  },
  {
    "marker": "surname",
    "type": "string",
    "value": "Nom de famille"
  },
  {
    "marker": "email",
    "type": "string",
    "value": "votre@email.com"
  },
  {
    "marker": "topic",
    "type": "list",
    "value": [
      {
        "title": "Article",
        "value": "article"
      }
    ]
  },
  {
    "marker": "text",
    "type": "text",
    "value": [
      {
        "htmlValue": "Du texte",
        "plainValue": "Du texte"
      }
    ]
  }
]

6. Poster les données du formulaire avec FormData.postFormsData()​

Exemple :

const formResponse = await FormData.postFormsData({
  formIdentifier: 'contact_us',
  formData: transformedFormData,
});
Résultat :
{
  "formData": {
    "formIdentifier": "contact_us",
    "time": "2025-04-30T20:12:39.209Z",
    "formData": [
      {
        "marker": "first_name",
        "type": "string",
        "value": "Prénom"
      },
      {
        "marker": "surname",
        "type": "string",
        "value": "Nom de famille"
      },
      {
        "marker": "email",
        "type": "string",
        "value": "votre@email.com"
      },
      {
        "marker": "topic",
        "type": "list",
        "value": [
          {
            "title": "Article",
            "value": "article"
          }
        ]
      },
      {
        "marker": "text",
        "type": "text",
        "value": [
          {
            "htmlValue": "Du texte",
            "plainValue": "Du texte"
          }
        ]
      }
    ],
    "id": 68
  },
  "actionMessage": "Message concernant le traitement réussi des données"
}

Exemple final​

// 1. Importer oneEntry et définir PROJECT_URL et APP_TOKEN
import { defineOneEntry } from 'oneentry';

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

// 2. Créer un client API 
const { FileUploading, FormData } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Obtenir le formulaire et trier les champs par position
const formData = await Forms.getFormByMarker('contact_us');
const formFields = formData?.attributes.slice().sort(
  (a: { position: number }, b: { position: number }) =>
    a.position - b.position,
);

// 4. Obtenir les données des champs depuis le formulaire frontend
const fieldsData = [
  {
    marker: 'first_name',
    value: 'Prénom',
  },
  {
    marker: 'surname',
    value: 'Nom de famille',
  },
  {
    marker: 'email',
    value: 'votre@email.com',
  },
  {
    marker: 'topic',
    value: [
      {
        title: 'Article',
        value: 'article',
      },
    ],
  },
  {
    marker: 'text',
    value: 'Du texte',
  },
];

// 5. Transformer les données pour une utilisation avec le formulaire OneEntry 
const transformedFormData = fieldsData.map((field: any) => {
  const { marker, value } = field;
  const formField = formFields.find(
    (field: { marker: string }) => field.marker === marker,
  );
  const { type } = formField;

  switch (type) {
    case 'text':
      return {
        marker,
        type: 'text',
        value: [
          {
            htmlValue: value,
            plainValue: value,
          },
        ],
      };
    default:
      return {
        marker,
        type,
        value,
      };
  }
});

// 6. Poster les données du formulaire avec FormData.postFormsData()
const formResponse = await FormData.postFormsData({
  formIdentifier: 'contact_us',
  formData: transformedFormData,
});
console.log(formResponse);