đăng ký
Đăng ký người dùng (❗️Đối với nhà cung cấp có kích hoạt người dùng, mã kích hoạt được gửi qua phương thức thông báo người dùng tương ứng)
AuthProvider.signUp(marker, body, langCode)
Schema
marker:* chuỗi
Định danh văn bản của nhà cung cấp ủy quyền
ví dụ: email
body:* ISignUpData
Nội dung yêu cầu
ví dụ:
{
"formIdentifier": "reg",
"authData": [
{ "marker": "login", "value": "example@oneentry.cloud" },
{ "marker": "password", "value": "12345" }
],
"formData": [
{ "marker": "last_name", "type": "string", "value": "Tên" }
],
"notificationData": {
"email": "example@oneentry.cloud",
"phonePush": ["+99999999999"],
"phoneSMS": "+99999999999"
}
}
langCode: chuỗi
Mã ngôn ngữ
ví dụ: en_US
Phương thức chấp nhận nội dung như một tham số.
Ví dụ cho tham số nội dung với các loại dữ liệu khác nhau:
Ví dụ với các thuộc tính của loại đơn giản formData "chuỗi", "số nguyên", "số thực".
{
"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"
}
}
Ví dụ với các thuộc tính của loại "ngày", "ngày giờ", "thời gian"
{
"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"
}
}
Ví dụ với thuộc tính của loại "văn bản"
{
"formIdentifier": "reg",
"langCode": "en_US",
"authData": [
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": {
"en_US": [
{
"marker": "about",
"type": "text",
"value": {
"htmlValue": "<p>Đây là tôi</p>",
"plainValue": "",
"params": {
"isEditorDisabled": false,
"isImageCompressed": true
}
}
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [],
"phoneSMS": "+19991234567"
}
}
Ví dụ với thuộc tính loại "văn bản có tiêu đề"
{
"formIdentifier": "reg",
"langCode": "en_US",
"authData": [
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": {
"en_US": [
{
"marker": "about",
"type": "textWithHeader",
"value": {
"header": "Tiêu đề",
"htmlValue": "<p>Đây là tôi</p>",
"plainValue": "",
"params": {
"isEditorDisabled": false,
"isImageCompressed": true
}
}
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [],
"phoneSMS": "+19991234567"
}
}
Ví dụ với các thuộc tính loại "hình ảnh" và "nhóm hình ảnh"
{
"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"
}
}
Ví dụ với thuộc tính loại "tệp"
{
"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"
}
}
Ví dụ với các thuộc tính loại "nút radio" và "danh sách"
{
"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": "string"
}
}
]
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [],
"phoneSMS": "+19991234567"
}
}
Ví dụ với thuộc tính loại "thực thể" (danh sách lồng nhau)
{
"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"
}
}
Ví dụ với một định danh đẩy
{
"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": "string"
}
}
]
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [
"7DD987F846400079F4B03C058365A4869047B4A0."
],
"phoneSMS": "+19991234567"
}
}
Ví dụ với nhiều định danh đẩy
{
"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": "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": "Tên người dùng"
}
],
"notificationData": {
"email": "test@test.com",
"phonePush": [],
"phoneSMS": "+99999999999"
}
}
const value = await AuthProvider.signUp('email', body)
Schema
formIdentifier: chuỗi
định danh văn bản của biểu mẫu nhà cung cấp ủy quyền
ví dụ: reg_form
formData:
dữ liệu biểu mẫu đính kèm với nhà cung cấp ủy quyền
authData:
dữ liệu ủy quyền lấy từ biểu mẫu đính kèm với nhà cung cấp ủy quyền
ví dụ:
[
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
]
notificationData:
dữ liệu thông báo người dùng
attributeSetId: số
định danh cho bộ thuộc tính đã sử dụng
ví dụ: 7
formData: FormDataLangType
Dữ liệu được gửi bởi biểu mẫu
ví dụ:
{
"en_US": [
{
"marker": "marker_1",
"value": "Tên"
}
]
}
notificationData: UserNotificationDataType
dữ liệu để thông báo cho người dùng
ví dụ:
{
"email": "test@test.zone",
"phonePush": "", "phoneSMS": "+19991234567"
}
systemCode: chuỗi
mã hệ thống để thực hiện các hành động chính thức (đặt lại mật khẩu, kích hoạt)
ví dụ:
{
"value": "90BDCX",
"expiredDate": "2024-05-07T21:02:00.000Z"
}
formIdentifier: chuỗi
định danh văn bản của biểu mẫu nhà cung cấp ủy quyền
ví dụ: reg_form
authData: FormAuthDataType
dữ liệu ủy quyền lấy từ biểu mẫu liên kết với nhà cung cấp ủy quyền
ví dụ:
[
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
]
authProviderId: số
ID của nhà cung cấp ủy quyền
ví dụ: 1
Phương thức này sẽ đăng ký một người dùng mới. Trả về đối tượng của người dùng đã đăng ký.
Ví dụ trả về:
{
"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": "Họ thứ hai"
}
],
"notificationData": {
"email": "test@test.com",
"phonePush": ["+999999999"],
"phoneSMS": "+9999999999"
},
"systemCode": {
"value": "90BDCX",
"expiredDate": "2024-05-07T21:02:00.000Z"
}
}
Schema
id: số
định danh đối tượng
ví dụ: 1764
updatedDate: chuỗi
ngày sửa đổi đối tượng
version: số
số phiên bản của đối tượng
ví dụ: 10
identifier: chuỗi
định danh văn bản cho bản ghi trường
ví dụ: catalog
mặc định: marker
attributeSetId: số
định danh cho bộ thuộc tính đã sử dụng
ví dụ: 7
formData: FormDataLangType
Dữ liệu được gửi bởi biểu mẫu
ví dụ:
{
"en_US": [
{
"marker": "marker_1",
"value": "Tên"
}
]
}
notificationData: UserNotificationDataType
dữ liệu để thông báo cho người dùng
ví dụ:
{
"email": "test@test.zone",
"phonePush": "",
"phoneSMS": "+19991234567"
}
systemCode: chuỗi
mã hệ thống để thực hiện các hành động chính thức (đặt lại mật khẩu, kích hoạt)
ví dụ:
{
"value": "90BDCX",
"expiredDate": "2024-05-07T21:02:00.000Z"
}
formIdentifier: chuỗi
định danh văn bản của biểu mẫu nhà cung cấp ủy quyền
ví dụ: reg_form
authData: FormAuthDataType
dữ liệu ủy quyền lấy từ biểu mẫu liên kết với nhà cung cấp ủy quyền
ví dụ:
[
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
]
authProviderId: số
ID của nhà cung cấp ủy quyền
ví dụ: 1