Aller au contenu principal

signUp

Inscription de l'utilisateur (❗️Pour les fournisseurs avec activation de l'utilisateur, un code d'activation est envoyé par le biais de la méthode de notification utilisateur correspondante)

Description​

La méthode accepte le corps comme paramètre. Elle renvoie une promesse qui se résout en un objet ISignUpEntity.

AuthProvider.signUp(

marker*, body*, body.formIdentifier*, body.langCode, body.authData*, body.formData*, formData.marker*, formData.type*, formData.value*, body.notificationData*, langCode

);

Schéma des paramètres​

Schéma

marker(obligatoire) : string
L'identifiant textuel du fournisseur d'autorisation
exemple : "email"

body(obligatoire) : ISignUpData
Corps de la requête
exemple :

{
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "example@oneentry.cloud"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "last_name",
      "type": "string",
      "value": "Name"
    }
  ],
  "notificationData": {
    "email": "example@oneentry.cloud",
    "phonePush": [
      "+99999999999"
    ],
    "phoneSMS": "+99999999999"
  }
}

body.formIdentifier(obligatoire) : string
L'identifiant pour le formulaire d'inscription.
exemple : "reg"

body.langCode : string
Code de langue. Par défaut : "en_US".

body.authData(obligatoire) : Array
Un tableau d'objets de données d'authentification, chacun contenant un marqueur et sa valeur correspondante.

body.formData(obligatoire) : IAuthFormData | IAuthFormData[]
Les données du formulaire pour l'inscription.

formData.marker(obligatoire) : string
Un identifiant unique pour le champ du formulaire.
exemple : "email"

formData.type(obligatoire) : string
Le type du champ du formulaire, tel que 'string', 'email', etc.
exemple : "string"

formData.value(obligatoire) : string
La valeur saisie dans le champ du formulaire.
exemple : "example@oneentry.cloud"

body.notificationData(obligatoire) : object
Un objet contenant des données de notification, y compris email, phonePush et phoneSMS.

langCode : string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples​

Exemple minimal​


const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "example@oneentry.cloud"
    },
    {
      "marker": "password",
      "value":"12345"
    }
  ],
  "formData": [
    {
      "marker": "last_name",
      "type": "string",
      "value": "Nom"
    }
  ],
  "notificationData": {
    "email": "example@oneentry.cloud",
    "phonePush": [
      "+99999999999"
    ],
    "phoneSMS": "+99999999999"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple avec des attributs de types simples formData "string", "integer", "float".​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "last_name",
      "type": "string",
      "value": "Fyodor Ivanov"
    }
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple avec des attributs de types "date", "dateTime", "time"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "birthday",
      "type": "date",
      "value": {
        "fullDate": "2024-05-07T21:02:00.000Z",
        "formattedValue": "08-05-2024 00:02",
        "formatString": "DD-MM-YYYY HH:mm"
      }
    }
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple avec un attribut de type "text"​

Pour une valeur de champ texte, vous pouvez utiliser l'un des trois types de valeur :

  • htmlValue - chaîne HTML
  • plainValue - chaîne
  • mdValue - chaîne Markdown
const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "text",
      "value": {
        "htmlValue": "<p>This is me</p>",
        // "plainValue": "",
        // "mdValue":  ""
      }
    }
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple avec un attribut de type "textWithHeader"​

Pour une valeur de champ textWithHeader, vous pouvez utiliser l'un des trois types de valeur :

  • htmlValue - chaîne HTML
  • plainValue - chaîne
  • mdValue - chaîne Markdown
const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "textWithHeader",
      "value": {
        "header": "Header",
        "htmlValue": "<p>This is me</p>",
        // "plainValue": "",
        // "mdValue":  ""
      }
    }
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple avec des attributs de type "image" et "groupOfImages"​

Si un objet fileQuery est fourni dans l'objet formData, le fichier sera automatiquement téléchargé sur le cloud OneEntry via le SDK ou utilisez le handle File.uploadFile() Voir exemple

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  formData: [
    {
      marker: "image",
      type: "image",
      value: [file],
      fileQuery: {
        type: "page",
        entity: "editor",
        id: 3492,
      },
    },
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple avec un attribut de type "file"​

Si un objet fileQuery est fourni dans l'objet formData, le fichier sera automatiquement téléchargé sur le cloud OneEntry via le SDK ou utilisez le handle File.uploadFile() Voir exemple

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  formData: [
    {
      marker: "image",
      type: "image",
      value: [file],
      fileQuery: {
        type: "page",
        entity: "editor",
        id: 3492,
      },
    },
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple avec des attributs de type "radioButton" et "list"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  formData: [
    {
      marker: "list",
      type: "list",
      value: ["1"],
    },
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple avec un attribut de type "entity" (liste imbriquée)​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  formData: [
    {
      marker: "entity",
      type: "entity",
      value: [2954, 2957],
    },
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = await AuthProvider.signUp('email', body);

Exemple de réponse​

{
  "createdDate": "2025-12-26T12:17:46.115Z",
  "deletedAt": null,
  "formData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "f-name",
      "value": "Second name"
    }
  ],
  "id": 286,
  "identifier": "user_email@gmail.com",
  "isActive": false,
  "isDeleted": false,
  "locale": "en_US",
  "notificationData": {
    "email": "user_email@gmail.com"
  },
  "email": "user_email@gmail.com",
  "state": {},
  "updatedDate": "2025-12-26T12:17:46.115Z",
  "version": 0
}

Schéma de réponse​

Schéma : ISignUpEntity

id : number
L'identifiant unique de l'entité d'inscription.
exemple : 12345

updatedDate : string
La date à laquelle l'entité d'inscription a été mise à jour pour la dernière fois.
exemple : "2023-10-01T12:00:00Z"

version : number
Le numéro de version de l'entité d'inscription.
exemple : 1

identifier : string
Une chaîne unique qui identifie l'entité d'inscription.
exemple : "signup_12345"

isActive : boolean
Indique si l'entité d'inscription est active.
exemple : true

formData : Array<object>
Un tableau d'objets représentant les données du formulaire, chacun contenant un marqueur et sa valeur correspondante.
exemple :

[
  {
    "marker": "first_name",
    "value": "John"
  },
  {
    "marker": "last_name",
    "value": "Doe"
  }
]

notificationData : object
Un objet contenant des données de notification, y compris email, phonePush et phoneSMS.
exemple :

{
  "email": "example@oneentry.cloud",
  "phonePush": [
    "+99999999999"
  ],
  "phoneSMS": "+99999999999"
}

locale : string
Le code de langue ou de localisation associé à l'entité d'inscription.
exemple : "en_US"