Saltar al contenido principal

signUp

Registro de usuario (❗️Para proveedores con activación de usuario, se envía un código de activación a través del método de notificación correspondiente al usuario)

AuthProvider?.signUp( marker?, body?, langCode? );

Ejemplo mínimo​

const body = {
"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"?
}
};

const value = await AuthProvider.signUp('email', body)
Esquema

marker(required): string
El identificador de texto del proveedor de autorización
ejemplo: "email"

body(required): ISignUpData
Cuerpo de la solicitud
ejemplo:

{
  "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"
  }
}

formIdentifier(required): string
El identificador para el formulario de registro.
ejemplo: "reg"

langCode: string
Código de idioma. Por defecto "en_US".

formData(required): IAuthFormData | IAuthFormData[]
Los datos del formulario para el registro, que pueden ser un solo objeto o un array de objetos.
ejemplo:

{
  "marker": "last_name",
  "type": "string",
  "value": "Name"
}

marker(required): string
Un identificador único para el campo del formulario.
ejemplo: "email"

type(required): string
El tipo del campo del formulario, como 'string', 'email', etc.
ejemplo: "string"

value(required): string
El valor ingresado en el campo del formulario.
ejemplo: "example@oneentry.cloud"

notificationData(required): Object
Un objeto que contiene datos de notificación, incluyendo email, phonePush y phoneSMS.
ejemplo:

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

langCode: string
Código de idioma. Por defecto: "en_US"
ejemplo: "en_US"

El método acepta el cuerpo como parámetro.

Ejemplos para el parámetro de cuerpo con diferentes tipos de datos:​

Ejemplo con atributos de tipos simples formData "string", "integer", "float".

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "last_name",
      "type": "string",
      "value": "Fyodor Ivanov"
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con atributos de tipos "date", "dateTime", "time"

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "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": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con atributo de tipo "text"

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "text",
      "value": {
        "htmlValue": "<p>Este soy yo</p>",
        "plainValue": "",
        "params": {
          "isEditorDisabled": false,
          "isImageCompressed": true
        }
      }
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con atributo tipo "textWithHeader"

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "textWithHeader",
      "value": {
        "header": "Encabezado",
        "htmlValue": "<p>Este soy yo</p>",
        "plainValue": "",
        "params": {
          "isEditorDisabled": false,
          "isImageCompressed": true
        }
      }
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con atributos tipo "image" y "groupOfImages"

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "avatar",
      "type": "image",
      "value": [
        {
          "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
          "downloadLink": "http://my-site.zone/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
          "size": 392585,
          "previewLink": "",
          "params": {
            "isImageCompressed": true
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con atributo tipo "file"

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "picture",
      "type": "file",
      "value": [
        {
          "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
          "downloadLink": "http://my-site.zone/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
          "size": 392585
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con atributos tipo "radioButton" y "list"

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "list",
      "value": [
        {
          "title": "rojo",
          "value": "1",
          "extended": {
            "value": "red",
            "type": "string"
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con atributo tipo "entity" (lista anidada)

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "entity-selector",
      "type": "entity",
      "value": [
        {
          "id": "1",
          "title": "rojo",
          "value": "1",
          "parentId": "null"
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con un identificador push

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "list",
      "value": [
        {
          "title": "rojo",
          "value": "1",
          "extended": {
            "value": "red",
            "type": "string"
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [
      "7DD987F846400079F4B03C058365A4869047B4A0."
    ],
    "phoneSMS": "+19991234567"
  }
}

Ejemplo con múltiples identificadores push

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "list",
      "value": [
        {
          "title": "rojo",
          "value": "1",
          "extended": {
            "value": "red",
            "type": "string"
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [
      "7DD987F846400079F4B03C058365A4869047B4A0",
      "7DD987F846400079F4B03C058365A4869047B4A0",
      "7DD987F846400079F4B03C058365A4869047B4A0."
    ],
    "phoneSMS": "+19991234567"
  }
}
const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "last_name",
      "type": "string",
      "value": "Nombre de usuario"
    }
  ],
  "notificationData": {
    "email": "test@test.com",
    "phonePush": [],
    "phoneSMS": "+99999999999"
  }
}

const value = await AuthProvider.signUp('email', body)
Esquema

formIdentifier: string
identificador textual del formulario del proveedor de autorización
ejemplo: reg_form

formData:
datos del formulario adjunto al proveedor de autorización

authData:
datos de autorización tomados del formulario adjunto al proveedor de autorización
ejemplo:

[ 
  { 
    "marker": "login", 
    "value": "test" 
  }, 
  { 
    "marker": "password", 
    "value": "12345" 
  } 
]

notificationData:
datos de notificación del usuario

attributeSetId: number
identificador para el conjunto de atributos utilizado
ejemplo: 7

formData: FormDataLangType
Datos enviados por el formulario
ejemplo:

{
  "en_US": [ 
    { 
      "marker": "marker_1", 
      "value": "Name" 
    } 
  ]
}

notificationData: UserNotificationDataType
datos para notificar al usuario
ejemplo:

{ 
  "email": "test@test.zone", 
  "phonePush": "", "phoneSMS": "+19991234567" 
}

systemCode: string
código del sistema para realizar acciones oficiales (restablecimiento de contraseña, activación)
ejemplo:

{ 
  "value": "90BDCX", 
  "expiredDate": "2024-05-07T21:02:00.000Z" 
}

formIdentifier: string
el identificador de texto del formulario del proveedor de autorización
ejemplo: reg_form

authData: FormAuthDataType
datos de autorización tomados del formulario vinculado al proveedor de autorización
ejemplo:

[ 
  { 
    "marker": "login", 
    "value": "test" 
  }, 
  { 
    "marker": "password", 
    "value": "12345" 
  } 
]

authProviderId: number
ID del proveedor de autorización
ejemplo: 1


Este método registrará un nuevo usuario. Devuelve el objeto del usuario registrado.

Ejemplo de retorno:

{
  "id": 1764,
  "updatedDate": "2024-05-23T12:43:00.169Z",
  "version": 10,
  "identifier": "catalog",
  "isActive": false,
  "authProviderId": 1,
  "formData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "f-name",
      "value": "Segundo nombre"
    }
  ],
  "notificationData": {
    "email": "test@test.com",
    "phonePush": ["+999999999"],
    "phoneSMS": "+9999999999"
  },
  "systemCode": {
    "value": "90BDCX",
    "expiredDate": "2024-05-07T21:02:00.000Z"
  }
}
Esquema

id: number
El identificador único de la entidad de registro.
ejemplo: 12345

updatedDate: string
La fecha en que se actualizó por última vez la entidad de registro.
ejemplo: "2023-10-01T12:00:00Z"

version: number
El número de versión de la entidad de registro.
ejemplo: 1

identifier: string
Una cadena única que identifica la entidad de registro.
ejemplo: "signup_12345"

isActive: boolean
Indica si la entidad de registro está activa.
ejemplo: true

notificationData: Object
Un objeto que contiene datos de notificación, incluyendo email, phonePush y phoneSMS.
ejemplo:

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

locale: string
El código de idioma o local asociado con la entidad de registro.
ejemplo: "en_US"