signUp

Kullanıcı kaydı (❗️Kullanıcı aktivasyonu gerektiren sağlayıcılar için, ilgili kullanıcı bildirim yöntemi aracılığıyla bir aktivasyon kodu gönderilir)

Açıklama

Yöntem, gövdeyi bir parametre olarak kabul eder. Bir ISignUpEntity nesnesine çözülen bir Promise döner.

AuthProvider.signUp(
marker*,
body*,
body.formIdentifier*,
body.langCode,
body.authData*,
body.formData*,
formData.marker*,
formData.type*,
formData.value*,
body.notificationData*,
notificationData.email*,
notificationData.phonePush*,
notificationData.phoneSMS,
langCode
);

Parametreler şeması

Şema

marker(gerekli): string
Yetkilendirme sağlayıcısının metin tanımlayıcısı
örnek: "email"

body(gerekli): ISignUpData
İstek gövdesi
örnek:

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

body.formIdentifier(gerekli): string
Kayıt formunun tanımlayıcısı.
örnek: "reg"

body.langCode: string
Dil kodu. Varsayılan: "en_US".

body.authData(gerekli): Array
Her biri bir işaretçi ve karşılık gelen değeri içeren bir kimlik doğrulama verisi nesneleri dizisi.

body.formData(gerekli): IAuthFormData | IAuthFormData[]
Kayıt için form verisi.

formData.marker(gerekli): string
Form alanı için benzersiz bir tanımlayıcı.
örnek: "email"

formData.type(gerekli): string
Form alanının türü, örneğin 'string', 'email' vb.
örnek: "string"

formData.value(gerekli): string
Form alanına girilen değer.
örnek: "example@oneentry.cloud"

body.notificationData(gerekli): INotificationData
E-posta, telefonPush ve telefonSMS dahil olmak üzere bildirim verilerini içeren bir nesne.

notificationData.email(gerekli): string
Bildirimler için kullanılan kullanıcının e-posta adresi.
örnek: "example@oneentry.cloud"

notificationData.phonePush(gerekli): string[]
Push bildirimleri için kullanılan telefon numaraları.
örnek: ["+19999999999"]

notificationData.phoneSMS: string
SMS bildirimleri için kullanılan telefon numarası.
örnek: "+19999999999"

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

Örnekler

Minimal örnek


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 response = await AuthProvider.signUp('email', body);

Basit türler formData "string", "integer", "float" ile özellik örneği.

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

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

"date", "dateTime", "time" türleri ile özellik örneği

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

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

"text" türünde özellik örneği

Bir metin alanı değeri için üç değer türünden birini kullanabilirsiniz:

htmlValue - HTML dizesi
plainValue - dize
mdValue - Markdown dizesi

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "text",
      "value": {
        "htmlValue": "<p>This is me</p>",
        // "plainValue": "",
        // "mdValue":  ""
      }
    }
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

"textWithHeader" türünde özellik örneği

Bir textWithHeader alanı değeri için üç değer türünden birini kullanabilirsiniz:

htmlValue - HTML dizesi
plainValue - dize
mdValue - Markdown dizesi

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "textWithHeader",
      "value": {
        "header": "Header",
        "htmlValue": "<p>This is me</p>",
        // "plainValue": "",
        // "mdValue":  ""
      }
    }
  ],
  "notificationData": {
    "email": "your-email@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

"image" ve "groupOfImages" türünde özellik örneği

Eğer formData nesnesinde bir fileQuery nesnesi sağlanırsa, dosya SDK aracılığıyla otomatik olarak OneEntry bulutuna yüklenecektir veya File.uploadFile() işlevini kullanabilirsiniz. örnek için bakın.

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

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

"file" türünde özellik örneği

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

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

"radioButton" ve "list" türünde özellik örneği

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

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

"entity" türünde özellik örneği (iç içe liste)

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

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

Örnek yanıt

{
  "identifier": "my-id",
  "id": 1764,
  "createdDate": "1991-08-18T06:18:10.986Z",
  "updatedDate": "1967-12-02T16:45:02.051Z",
  "version": 10,
  "isActive": false,
  "isDeleted": false,
  "formData": {
    "en_US": [
      {
        "marker": "login",
        "type": "string",
        "value": "test"
      },
      {
        "marker": "f-name",
        "type": "string",
        "value": "Ivanov"
      }
    ]
  },
  "state": {},
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+89991234567"
  },
  "locale": "en_US",
  "deletedAt": "2023-02-12 10:56",
  "rating": {
    "value": 4.5,
    "like": 10,
    "dislike": 2,
    "method": "average"
  }
}

Yanıt şeması

Şema: ISignUpEntity

id: number
Kayıt varlığının benzersiz tanımlayıcısı.
örnek: 12345

updatedDate: string
Kayıt varlığının en son güncellendiği tarih.
örnek: "2023-10-01T12:00:00Z"

version: number
Kayıt varlığının sürüm numarası.
örnek: 1

identifier: string
Kayıt varlığını tanımlayan benzersiz bir dize.
örnek: "signup_12345"

isActive: boolean
Kayıt varlığının aktif olup olmadığını gösterir.
örnek: true

formData: IAuthFormData[]
Form verileri dizisi.
örnek:

[
  {
    "marker": "first_name",
    "value": "John"
  }
]

formData.marker: string
Form alanı için benzersiz bir tanımlayıcı.
örnek: "email"

formData.type: string
Form alanının türü, örneğin 'string', 'email' vb.
örnek: "string"

formData.value: string
Form alanına girilen değer.
örnek: "example@oneentry.cloud"

notificationData: INotificationData
E-posta, telefonPush ve telefonSMS dahil olmak üzere bildirim verilerini içeren bir nesne.
örnek:

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

notificationData.email: string
Bildirimler için kullanılan kullanıcının e-posta adresi.
örnek: "example@oneentry.cloud"

notificationData.phonePush: string[]
Push bildirimleri için kullanılan telefon numaraları.
örnek: ["+19999999999"]

notificationData.phoneSMS: string
SMS bildirimleri için kullanılan telefon numarası.
örnek: "+19999999999"

locale: string
Kayıt varlığı ile ilişkili yerel veya dil kodu.
örnek: "en_US"

createdDate: string
Kayıt varlığının oluşturulduğu tarih.
örnek: "2023-10-01T12:00:00Z"

importId: unknown
İthalat tanımlayıcısı.
örnek: null

deletedAt: string | null
Silinme tarihi veya null.
örnek: null

isDeleted: boolean
Varlığın silinip silinmediği.
örnek: false

state: Record<string, unknown>
Ek durum bilgileri.
örnek:

rating: IRating
Değerlendirme verileri.

Açıklama​

Parametreler şeması​

Örnekler​

Minimal örnek​

Basit türler formData "string", "integer", "float" ile özellik örneği.​

"date", "dateTime", "time" türleri ile özellik örneği​

"text" türünde özellik örneği​

"textWithHeader" türünde özellik örneği​

"image" ve "groupOfImages" türünde özellik örneği​

"file" türünde özellik örneği​

"radioButton" ve "list" türünde özellik örneği​

"entity" türünde özellik örneği (iç içe liste)​

Örnek yanıt​

Yanıt şeması​