Pular para o conteúdo principal

signUp

Registro de usuário (❗️Para provedores com ativação de usuário, um código de ativação é enviado através do método de notificação correspondente ao usuário)

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

Exemplo 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(obrigatório): string
O identificador de texto do provedor de autorização
exemplo: "email"

body(obrigatório): ISignUpData
Corpo da solicitação
exemplo:

{
  "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(obrigatório): string
O identificador para o formulário de registro.
exemplo: "reg"

langCode: string
Código do idioma. Padrão "en_US".

formData(obrigatório): IAuthFormData | IAuthFormData[]
Os dados do formulário para o registro, que podem ser um único objeto ou um array de objetos.
exemplo:

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

marker(obrigatório): string
Um identificador único para o campo do formulário.
exemplo: "email"

type(obrigatório): string
O tipo do campo do formulário, como 'string', 'email', etc.
exemplo: "string"

value(obrigatório): string
O valor inserido no campo do formulário.
exemplo: "example@oneentry.cloud"

notificationData(obrigatório): Object
Um objeto contendo dados de notificação, incluindo email, phonePush e phoneSMS.
exemplo:

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

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

O método aceita o corpo como um parâmetro.

Exemplos para o parâmetro body com diferentes tipos de dados:​

Exemplo com 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"
  }
}

Exemplo com atributos dos 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"
  }
}

Exemplo com atributo do 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 sou eu</p>",
        "plainValue": "",
        "params": {
          "isEditorDisabled": false,
          "isImageCompressed": true
        }
      }
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Exemplo com atributo do tipo "textWithHeader"

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

Exemplo com atributos do tipo "image" e "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"
  }
}

Exemplo com atributo do 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"
  }
}

Exemplo com atributos do tipo "radioButton" e "list"

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

Exemplo com atributo do tipo "entity" (lista aninhada)

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

Exemplo com um identificador de push

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

Exemplo com múltiplos identificadores de push

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "list",
      "value": [
        {
          "title": "vermelho",
          "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": "Nome de usuário"
    }
  ],
  "notificationData": {
    "email": "test@test.com",
    "phonePush": [],
    "phoneSMS": "+99999999999"
  }
}

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

formIdentifier: string
identificador textual do formulário do provedor de autorização
exemplo: reg_form

formData:
dados do formulário anexados ao provedor de autorização

authData:
dados de autorização retirados do formulário anexado ao provedor de autorização
exemplo:

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

notificationData:
dados de notificação do usuário

attributeSetId: number
identificador para o conjunto de atributos utilizado
exemplo: 7

formData: FormDataLangType
Dados submetidos pelo formulário
exemplo:

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

notificationData: UserNotificationDataType
dados para notificar o usuário
exemplo:

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

systemCode: string
código do sistema para realizar ações oficiais (reset de senha, ativação)
exemplo:

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

formIdentifier: string
o identificador de texto do formulário do provedor de autorização
exemplo: reg_form

authData: FormAuthDataType
dados de autorização retirados do formulário vinculado ao provedor de autorização
exemplo:

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

authProviderId: number
ID do provedor de autorização
exemplo: 1


Este método registrará um novo usuário. Retorna o objeto do usuário registrado.

Exemplo 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": "Sobrenome"
    }
  ],
  "notificationData": {
    "email": "test@test.com",
    "phonePush": ["+999999999"],
    "phoneSMS": "+9999999999"
  },
  "systemCode": {
    "value": "90BDCX",
    "expiredDate": "2024-05-07T21:02:00.000Z"
  }
}
Esquema

id: number
O identificador único da entidade de registro.
exemplo: 12345

updatedDate: string
A data em que a entidade de registro foi atualizada pela última vez.
exemplo: "2023-10-01T12:00:00Z"

version: number
O número da versão da entidade de registro.
exemplo: 1

identifier: string
Uma string única que identifica a entidade de registro.
exemplo: "signup_12345"

isActive: boolean
Indica se a entidade de registro está ativa.
exemplo: true

notificationData: Object
Um objeto contendo dados de notificação, incluindo email, phonePush e phoneSMS.
exemplo:

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

locale: string
O locale ou código de idioma associado à entidade de registro.
exemplo: "en_US"