signUp

تسجيل المستخدم (❗️للمزود مع تفعيل المستخدم، يتم إرسال رمز التفعيل من خلال طريقة الإشعار المناسبة للمستخدم)

AuthProvider.signUp(marker, body, langCode)

Schema

marker:* string
معرف نصي لمزود التفويض
مثال: email

body:* ISignUpData
جسم الطلب
مثال:

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

langCode: string
رمز اللغة
مثال: en_US

تقبل الطريقة الجسم كمعامل.

أمثلة لمعامل الجسم مع أنواع بيانات مختلفة:

مثال مع سمات من أنواع بسيطة 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"
  }
}

مثال مع سمات من أنواع "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"
  }
}

مثال مع سمة من نوع "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>This is me</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": "Header",
          "htmlValue": "<p>This is me</p>",
          "plainValue": "",
          "params": {
            "isEditorDisabled": false,
            "isImageCompressed": true
          }
        }
      }
    ]
  },
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
}

مثال مع سمات من نوع "image" و "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"
  }
}

مثال مع سمة من نوع "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"
  }
}

مثال مع سمات من نوع "radioButton" و "list"

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

مثال مع سمة من نوع "entity" (قائمة متداخلة)

{
  "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": "red",
            "value": "1",
            "parentId": "null"
          }
        ]
      }
    ]
  },
  "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": "selector",
        "type": "list",
        "value": [
          {
            "title": "red",
            "value": "1",
            "extended": {
              "value": "red",
              "type": "string"
            }
          }
        ]
      }
    ]
  },
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [
      "7DD987F846400079F4B03C058365A4869047B4A0."
    ],
    "phoneSMS": "+19991234567"
  }
}

مثال مع معرفات دفع متعددة

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

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

Schema

formIdentifier: string
معرف نصي لنموذج مزود التفويض مثال: reg_form

formData:
بيانات النموذج المرفقة بمزود التفويض

authData:
بيانات التفويض المأخوذة من النموذج المرفق بمزود التفويض
مثال:

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

notificationData:
بيانات إشعار المستخدم

attributeSetId: number
معرف لمجموعة السمات المستخدمة
مثال: 7

formData: FormDataLangType
البيانات المقدمة من النموذج
مثال:

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

notificationData: UserNotificationDataType
بيانات لإشعار المستخدم
مثال:

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

systemCode: string
رمز النظام لتنفيذ الإجراءات الرسمية (إعادة تعيين كلمة المرور، التفعيل)
مثال:

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

formIdentifier: string
المعرف النصي لنموذج مزود التفويض
مثال: reg_form

authData: FormAuthDataType
بيانات التفويض المأخوذة من النموذج المرتبط بمزود التفويض
مثال:

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

authProviderId: number
معرف مزود التفويض
مثال: 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": "Second name"
      }
  ],
  "notificationData": {
    "email": "test@test.com",
    "phonePush": ["+999999999"],
    "phoneSMS": "+9999999999"
  },
  "systemCode": {
    "value": "90BDCX",
    "expiredDate": "2024-05-07T21:02:00.000Z"
  }
}

Schema

id: number
معرف الكائن مثال: 1764

updatedDate: string
تاريخ تعديل الكائن

version: number
رقم إصدار الكائن
مثال: 10

identifier: string
معرف نصي لسجل الحقل
مثال: catalog
افتراضي: marker

attributeSetId: number
معرف لمجموعة السمات المستخدمة
مثال: 7

formData: FormDataLangType
البيانات المقدمة من النموذج
مثال:

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

notificationData: UserNotificationDataType
بيانات لإشعار المستخدم
مثال:

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

systemCode: string
رمز النظام لتنفيذ الإجراءات الرسمية (إعادة تعيين كلمة المرور، التفعيل)
مثال:

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

formIdentifier: string
المعرف النصي لنموذج مزود التفويض
مثال: reg_form

authData: FormAuthDataType
بيانات التفويض المأخوذة من النموذج المرتبط بمزود التفويض
مثال:

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

authProviderId: number
معرف مزود التفويض
مثال: 1