Aller au contenu principal

Inscription utilisateur

Dans cet exemple, nous démontrons comment enregistrer un nouvel utilisateur en utilisant l'API OneEntry.

✅ Objectif du scénario :

  • Nous obtenons le formulaire d'inscription pour générer le formulaire frontend.
  • L'utilisateur saisit les données requises et s'inscrit.
  • Après l'inscription, l'utilisateur reçoit un code d'activation par e-mail/sms.
  • L'utilisateur saisit le code d'activation et active l'utilisateur créé.

✅ Ce dont vous avez besoin :

  • Une PROJECT_URL et un APP_TOKEN valides pour l'authentification avec l'API OneEntry.
  • Formulaire d'inscription avec le marqueur "reg".
  • Champs de formulaire (attributs) avec les marqueurs "email_reg", "password_reg", "name_reg", "phone_reg".
  • Un e-mail/numéro de téléphone valide pour recevoir le code d'activation.

📌 Important :

  • 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éation d'un client API avec la fonction defineOneEntry()​

Exemple :

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

3. Nous obtenons un formulaire d'inscription avec Forms.getFormByMarker() pour générer un formulaire frontend​

Exemple :

const form = await Forms.getFormByMarker('reg');
Résultat :
{
  "id": 4,
  "attributeSetId": 5,
  "type": "sing_in_up",
  "localizeInfos": {
    "title": "Inscription",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 0,
  "position": 1,
  "identifier": "reg",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "string",
      "marker": "email_reg",
      "isLogin": true,
      "isSignUp": false,
      "position": 1,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        },
        "emailInspectionValidator": true
      },
      "localizeInfos": {
        "title": "E-mail"
      },
      "additionalFields": [],
      "isNotificationEmail": false,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "name_reg",
      "isLogin": null,
      "isSignUp": true,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        }
      },
      "localizeInfos": {
        "title": "Nom"
      },
      "additionalFields": [],
      "isNotificationEmail": false,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "phone_reg",
      "isLogin": null,
      "isSignUp": true,
      "position": 3,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        }
      },
      "localizeInfos": {
        "title": "Téléphone"
      },
      "additionalFields": [],
      "isNotificationEmail": false,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "password_reg",
      "isLogin": null,
      "isSignUp": null,
      "position": 4,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        },
        "stringInspectionValidator": {
          "stringMax": 0,
          "stringMin": 0,
          "stringLength": 0
        }
      },
      "localizeInfos": {
        "title": "Mot de passe"
      },
      "additionalFields": [],
      "isNotificationEmail": false,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "email_notification_reg",
      "isLogin": null,
      "isSignUp": null,
      "position": 5,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "e-mail pour notification"
      },
      "additionalFields": [],
      "isNotificationEmail": true,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

4. Préparation des données pour l'inscription de l'utilisateur et inscription de l'utilisateur avec AuthProvider.signUp()​

Données :

{
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "email_reg",
      "value": "your-user@email.com"
    },
    {
      "marker": "password_reg",
      "value": "123456"
    }
  ],
  "formData": {
    "en_US": [
      {
        "marker": "name_reg",
        "type": "string",
        "value": "UserName"
      },
      {
        "marker": "phone_reg",
        "type": "string",
        "value": "+18007986545"
      },
      {
        "marker": "email_notification_reg",
        "type": "string",
        "value": "your-user@email.com"
      }
    ]
  },
  "notificationData": {
    "email": "your-user@email.com",
    "phonePush": [],
    "phoneSMS": "+18007986545"
  },
  "langCode": "en_US"
}

Exemple :

const newUser = await AuthProvider.signUp('email', registrationData);
Résultat :
{
  "identifier": "your-user@email.com",
  "isActive": false,
  "formData": [
    {
      "marker": "name_reg",
      "type": "string",
      "value": "UserName"
    },
    {
      "marker": "phone_reg",
      "type": "string",
      "value": "+18007986545"
    },
    {
      "marker": "email_notification_reg",
      "type": "string",
      "value": "your-user@email.com"
    }
  ],
  "notificationData": {
    "email": "your-user@email.com",
    "phonePush": [],
    "phoneSMS": "+18007986545"
  },
  "locale": "en_US",
  "updatedDate": "2025-04-30T20:07:38.156Z",
  "deletedAt": null,
  "id": 33,
  "version": 0,
  "state": {}
}

5. Générer un code de confirmation avec AuthProvider.generateCode() envoyé par e-mail/sms​

Données :

your-user@email.com

Exemple :

const generateCode = await AuthProvider.generateCode('email', emailReg, 'auth');
Résultat :
{
  "statusCode": 400,
  "timestamp": "2025-04-30T20:07:39.755Z",
  "message": "L'utilisateur a déjà un code",
  "pageData": null
}

6. L'utilisateur saisit le code → vérification​

Exemple :

const code = prompt('Entrez le code de vérification :') as string;

7. Vérifier le code avec AuthProvider.checkCode() Si le code est correct, activer l'utilisateur​

Exemple :

const isCorrect = await AuthProvider.checkCode(
  'email',
  emailReg,
  '1',
  code,
);
if (isCorrect) {
  await AuthProvider.activateUser('email', emailReg, code);
  console.log('✅ Utilisateur activé !');
} else {
  console.log('❌ Code de vérification invalide');
}

8. Authentification de l'utilisateur avec AuthProvider.auth()​

Exemple :

const authResponse = await AuthProvider.auth('email', {
  authData,
});
Résultat :
{
  "userIdentifier": "your-user@email.com",
  "authProviderIdentifier": "email",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR...pZCI6MTYsImF1dGhQ"
  "refreshToken": "1745494429101-...-2834edf8"
}

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';

const emailReg = 'your-user@email.com';

// 2. Création d'un client API :
const { Forms, AuthProvider } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Nous obtenons un formulaire d'inscription avec des champs personnalisés pour générer un formulaire frontend
const form = await Forms.getFormByMarker('reg');

// 4. Préparation des données pour l'inscription de l'utilisateur et inscription de l'utilisateur
const authData = [
  {
    marker: 'email_reg',
    value: 'your-user@email.com',
  },
  {
    marker: 'password_reg',
    value: '123456',
  },
];
const formData = [
  {
    marker: 'name_reg',
    type: 'string',
    value: 'UserName',
  },
  {
    marker: 'phone_reg',
    type: 'string',
    value: '+18007986545',
  },
  {
    marker: 'email_notification_reg',
    type: 'string',
    value: emailReg,
  },
];
const notificationData = {
  email: emailReg,
  phonePush: [],
  phoneSMS: '+18007986545',
};
const registrationData = {
  formIdentifier: 'reg',
  authData: authData,
  formData: formData,
  notificationData: notificationData,
};
let newUser = await AuthProvider.signUp('email', registrationData);

// 5. Générer un code de confirmation (envoyé par e-mail)
let generateCode = await AuthProvider.generateCode('email', emailReg, 'auth');

// 6. L'utilisateur saisit le code → vérification
const code = prompt('Entrez le code de vérification :') as string;

// 7. Activation de l'utilisateur
const isCorrect = await AuthProvider.checkCode(
  'email',
  emailReg,
  '1',
  code,
);

if (isCorrect) {
  await AuthProvider.activateUser('email', emailReg, code);
  console.log('✅ Utilisateur activé !');
} else {
  console.log('❌ Code de vérification invalide');
}

// 8. Authentification de l'utilisateur
const authResponse = await AuthProvider.auth('email', {
  authData,
});
console.log(authResponse);