Saltar al contenido principal

signUp

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

AuthProvider.signUp(marker, body, langCode)

Esquema

marker:* string
El identificador de texto del proveedor de autorización
ejemplo: email

body:* 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": "Nombre" } 
  ], 
  "notificationData": { 
    "email": "example@oneentry.cloud", 
    "phonePush": ["+99999999999"],
    "phoneSMS": "+99999999999"
  }
}

langCode: string
Código de idioma
ejemplo: en_US

El método acepta el cuerpo como un 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": {
    "en_US": [
      {
        "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": {
    "en_US": [
      {
        "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": {
    "en_US": [
      {
        "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": {
    "en_US": [
      {
        "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": {
    "en_US": [
      {
        "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": {
    "en_US": [
      {
        "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": {
    "en_US": [
      {
        "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": {
    "en_US": [
      {
        "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 de push

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": {
    "en_US": [
      {
        "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 de push

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": {
    "en_US": [
      {
        "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 adjuntos 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 del conjunto de atributos utilizados
ejemplo: 7

formData: FormDataLangType
Datos enviados por el formulario
ejemplo:

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

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
identificador del objeto ejemplo: 1764

updatedDate: string
fecha de modificación del objeto

version: number
número de versión del objeto
ejemplo: 10

identifier: string
identificador textual para el registro del campo
ejemplo: catalog
predeterminado: marker

attributeSetId: number
identificador del conjunto de atributos utilizados
ejemplo: 7

formData: FormDataLangType
Datos enviados por el formulario
ejemplo:

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

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