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)

Descrição​

O método aceita o corpo como um parâmetro. Ele retorna uma Promise que resolve para um objeto ISignUpEntity.

AuthProvider.signUp(

marker*, body*, formIdentifier*, langCode, formData

);

Esquema de parâmetros​

Esquema

marker(required): string
O identificador de texto do provedor de autorização
exemplo: "email"

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

body.formIdentifier(required): string
O identificador do formulário de registro.
exemplo: "reg"

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

body.formData(required): 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": "Nome"
}

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

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

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

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

{
  "email": "example@oneentry.cloud", // Campo de notificações por email. Obrigatório.
  "phonePush": [
    "+99999999999"
  ],                                 // Campo de notificações por push. Opcional.
  "phoneSMS": "+99999999999"         // Campo de notificações por SMS. Opcional.
}

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

Exemplos​

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

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

Exemplo com atributos de tipos simples formData "string", "integer", "float".​

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

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

Exemplo com atributos de tipos "date", "dateTime", "time"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "teste"
    },
    {
      "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": "seu-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

Exemplo com atributo de tipo "text"​

Para um valor de campo de texto, você pode usar um dos três tipos de valor:

  • htmlValue - string HTML
  • plainValue - string
  • mdValue - string Markdown
const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "teste"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "text",
      "value": {
        "htmlValue": "<p>Este sou eu</p>",
        // "plainValue": "",
        // "mdValue":  ""
      }
    }
  ],
  "notificationData": {
    "email": "seu-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

Exemplo com atributo tipo "textWithHeader"​

Para um valor de campo textWithHeader, você pode usar um dos três tipos de valor:

  • htmlValue - string HTML
  • plainValue - string
  • mdValue - string Markdown
const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "teste"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "textWithHeader",
      "value": {
        "header": "Cabeçalho",
        "htmlValue": "<p>Este sou eu</p>",
        // "plainValue": "",
        // "mdValue":  ""
      }
    }
  ],
  "notificationData": {
    "email": "seu-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

Exemplo com atributos tipo "image" e "groupOfImages"​

Se um objeto fileQuery for fornecido no objeto formData, o arquivo será automaticamente enviado para a nuvem OneEntry via SDK ou use o File.uploadFile() handle Veja exemplo

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

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

Exemplo com atributo tipo "file"​

Se um objeto fileQuery for fornecido no objeto formData, o arquivo será automaticamente enviado para a nuvem OneEntry via SDK ou use o File.uploadFile() handle Veja exemplo

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

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

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

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

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

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

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

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

Exemplo de resposta​

{
  "createdDate": "2025-12-26T12:17:46.115Z",
  "deletedAt": null,
  "formData": [
    {
      "marker": "login",
      "value": "teste"
    },
    {
      "marker": "f-name",
      "value": "Segundo nome"
    }
  ],
  "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
}

Esquema de resposta​

Esquema: ISignUpEntity

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"