Перейти к основному контенту

signUp

Регистрация пользователя (❗️Для провайдера с активацией пользователя, код активации отправляется через соответствующий метод уведомления пользователя)

AuthProvider.signUp(marker, body, langCode)

Схема

marker:* строка
Текстовый идентификатор провайдера авторизации
пример: email

body:* ISignUpData
Тело запроса
пример:

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

langCode: строка
Код языка
пример: en_US

Метод принимает тело в качестве параметра.

Примеры для параметра body с данными различных типов:

Пример с атрибутами простых типов formData "строка", "целое число", "число с плавающей запятой".

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": {
    "en_US": [
      {
        "marker": "last_name",
        "type": "string",
        "value": "Фёдор Иванов"
      }
    ]
  },
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Пример с атрибутами типов "дата", "дата и время", "время"

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

Пример с атрибутом типа "текст"

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

Пример с атрибутом типа "textWithHeader"

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": {
    "en_US": [
      {
        "marker": "about",
        "type": "textWithHeader",
        "value": {
          "header": "Заголовок",
          "htmlValue": "<p>Это я</p>",
          "plainValue": "",
          "params": {
            "isEditorDisabled": false,
            "isImageCompressed": true
          }
        }
      }
    ]
  },
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Пример с атрибутами типа "изображение" и "группа изображений"

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

Пример с атрибутом типа "файл"

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

Пример с атрибутами типа "radioButton" и "список"

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": {
    "en_US": [
      {
        "marker": "selector",
        "type": "list",
        "value": [
          {
            "title": "красный",
            "value": "1",
            "extended": {
              "value": "красный",
              "type": "строка"
            }
          }
        ]
      }
    ]
  },
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Пример с атрибутом типа "сущность" (вложенный список)

{
  "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": "красный",
            "value": "1",
            "parentId": "null"
          }
        ]
      }
    ]
  },
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

Пример с одним идентификатором push

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": {
    "en_US": [
      {
        "marker": "selector",
        "type": "list",
        "value": [
          {
            "title": "красный",
            "value": "1",
            "extended": {
              "value": "красный",
              "type": "строка"
            }
          }
        ]
      }
    ]
  },
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [
      "7DD987F846400079F4B03C058365A4869047B4A0."
    ],
    "phoneSMS": "+19991234567"
  }
}

Пример с несколькими идентификаторами push

{
  "formIdentifier": "reg",
  "langCode": "en_US",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": {
    "en_US": [
      {
        "marker": "selector",
        "type": "list",
        "value": [
          {
            "title": "красный",
            "value": "1",
            "extended": {
              "value": "красный",
              "type": "строка"
            }
          }
        ]
      }
    ]
  },
  "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": "Имя пользователя"
    }
  ],
  "notificationData": {
    "email": "test@test.com",
    "phonePush": [],
    "phoneSMS": "+99999999999"
  }
}

const value = await AuthProvider.signUp('email', body)
Схема

formIdentifier: строка
текстовый идентификатор формы провайдера авторизации пример: reg_form

formData:
данные формы, прикрепленные к провайдеру авторизации

authData:
данные авторизации, полученные из формы, прикрепленной к провайдеру авторизации
пример:

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

notificationData:
данные уведомления пользователя

attributeSetId: число
идентификатор используемого набора атрибутов
пример: 7

formData: FormDataLangType
Данные, отправленные формой
пример:

{
  "en_US": [ 
    { 
      "marker": "marker_1", 
      "value": "Имя" 
    } 
  ]
}

notificationData: UserNotificationDataType
данные для уведомления пользователя
пример:

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

systemCode: строка
системный код для выполнения официальных действий (сброс пароля, активация)
пример:

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

formIdentifier: строка
текстовый идентификатор формы провайдера авторизации
пример: reg_form

authData: FormAuthDataType
данные авторизации, полученные из формы, связанной с провайдером авторизации
пример:

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

authProviderId: число
ID провайдера авторизации
пример: 1


Этот метод зарегистрирует нового пользователя. Возвращает объект зарегистрированного пользователя.

Пример возвращаемого значения:

{
  "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": "Второе имя"
      }
  ],
  "notificationData": {
    "email": "test@test.com",
    "phonePush": ["+999999999"],
    "phoneSMS": "+9999999999"
  },
  "systemCode": {
    "value": "90BDCX",
    "expiredDate": "2024-05-07T21:02:00.000Z"
  }
}
Схема

id: число
идентификатор объекта
пример: 1764

updatedDate: строка
дата изменения объекта

version: число
номер версии объекта
пример: 10

identifier: строка
текстовый идентификатор записи поля
пример: catalog
по умолчанию: marker

attributeSetId: число
идентификатор используемого набора атрибутов
пример: 7

formData: FormDataLangType
Данные, отправленные формой
пример:

{
  "en_US": [
    {
      "marker": "marker_1",
      "value": "Имя"
    }
  ]
}

notificationData: UserNotificationDataType
данные для уведомления пользователя
пример:

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

systemCode: строка
системный код для выполнения официальных действий (сброс пароля, активация)
пример:

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

formIdentifier: строка
текстовый идентификатор формы провайдера авторизации
пример: reg_form

authData: FormAuthDataType
данные авторизации, полученные из формы, связанной с провайдером авторизации
пример:

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

authProviderId: число
ID провайдера авторизации
пример: 1