kayıt ol
Kullanıcı kaydı (❗️Kullanıcı aktivasyonu olan sağlayıcı için, aktivasyon kodu ilgili kullanıcı bildirim yöntemiyle gönderilir)
AuthProvider.signUp(marker, body, langCode)
Şema
marker:* string
Yetkilendirme sağlayıcısının metin tanımlayıcısı
örnek: email
body:* 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": "Ad" }
],
"notificationData": {
"email": "example@oneentry.cloud",
"phonePush": ["+99999999999"],
"phoneSMS": "+99999999999"
}
}
langCode: string
Dil kodu
örnek: en_US
Yöntem, gövdeyi bir parametre olarak kabul eder.
Farklı türlerde veri içeren gövde parametresi için örnekler:
Basit türler formData "string", "integer", "float" özellikleri ile örnek.
{
"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" türleri ile özellik içeren örnek
{
"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"
}
}
"metin" türünde özellik içeren örnek
{
"formIdentifier": "reg",
"langCode": "en_US",
"authData": [
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": {
"en_US": [
{
"marker": "about",
"type": "text",
"value": {
"htmlValue": "<p>Bu benim</p>",
"plainValue": "",
"params": {
"isEditorDisabled": false,
"isImageCompressed": true
}
}
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [],
"phoneSMS": "+19991234567"
}
}
"header ile metin" türünde özellik içeren örnek
{
"formIdentifier": "reg",
"langCode": "en_US",
"authData": [
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": {
"en_US": [
{
"marker": "about",
"type": "textWithHeader",
"value": {
"header": "Başlık",
"htmlValue": "<p>Bu benim</p>",
"plainValue": "",
"params": {
"isEditorDisabled": false,
"isImageCompressed": true
}
}
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [],
"phoneSMS": "+19991234567"
}
}
"resim" ve "resim grubu" türünde özellik içeren örnek
{
"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"
}
}
"dosya" türünde özellik içeren örnek
{
"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" ve "liste" türünde özellik içeren örnek
{
"formIdentifier": "reg",
"langCode": "en_US",
"authData": [
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": {
"en_US": [
{
"marker": "selector",
"type": "list",
"value": [
{
"title": "kırmızı",
"value": "1",
"extended": {
"value": "red",
"type": "string"
}
}
]
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [],
"phoneSMS": "+19991234567"
}
}
"varlık" türünde özellik içeren örnek (iç içe liste)
{
"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": "kırmızı",
"value": "1",
"parentId": "null"
}
]
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [],
"phoneSMS": "+19991234567"
}
}
Tek bir push tanımlayıcı ile örnek
{
"formIdentifier": "reg",
"langCode": "en_US",
"authData": [
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": {
"en_US": [
{
"marker": "selector",
"type": "list",
"value": [
{
"title": "kırmızı",
"value": "1",
"extended": {
"value": "red",
"type": "string"
}
}
]
}
]
},
"notificationData": {
"email": "test@test.zone",
"phonePush": [
"7DD987F846400079F4B03C058365A4869047B4A0."
],
"phoneSMS": "+19991234567"
}
}
Birden fazla push tanımlayıcısı ile örnek
{
"formIdentifier": "reg",
"langCode": "en_US",
"authData": [
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": {
"en_US": [
{
"marker": "selector",
"type": "list",
"value": [
{
"title": "kırmızı",
"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": "Kullanıcı adı"
}
],
"notificationData": {
"email": "test@test.com",
"phonePush": [],
"phoneSMS": "+99999999999"
}
}
const value = await AuthProvider.signUp('email', body)
Şema
formIdentifier: string
yetkilendirme sağlayıcısının formunun metinsel tanımlayıcısı
örnek: reg_form
formData:
yetkilendirme sağlayıcısına eklenen form verisi
authData:
yetkilendirme sağlayıcısına eklenen formdan alınan yetkilendirme verisi
örnek:
[
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
]
notificationData:
kullanıcı bildirim verisi
attributeSetId: number
kullanılan özellik setinin tanımlayıcısı
örnek: 7
formData: FormDataLangType
formdan gönderilen veri
örnek:
{
"en_US": [
{
"marker": "marker_1",
"value": "Ad"
}
]
}
notificationData: UserNotificationDataType
kullanıcıyı bilgilendirmek için veri
örnek:
{
"email": "test@test.zone",
"phonePush": "", "phoneSMS": "+19991234567"
}
systemCode: string
sahip olduğu resmi işlemleri gerçekleştirmek için sistem kodu (şifre sıfırlama, aktivasyon)
örnek:
{
"value": "90BDCX",
"expiredDate": "2024-05-07T21:02:00.000Z"
}
formIdentifier: string
yetkilendirme sağlayıcısının formunun metin tanımlayıcısı
örnek: reg_form
authData: FormAuthDataType
yetkilendirme sağlayıcısına bağlı formdan alınan yetkilendirme verisi
örnek:
[
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
]
authProviderId: number
yetkilendirme sağlayıcısının ID'si
örnek: 1
Bu yöntem yeni bir kullanıcı kaydedecektir. Kayıtlı kullanıcının nesnesini döndürür.
Örnek dönüş:
{
"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": "İkinci ad"
}
],
"notificationData": {
"email": "test@test.com",
"phonePush": ["+999999999"],
"phoneSMS": "+9999999999"
},
"systemCode": {
"value": "90BDCX",
"expiredDate": "2024-05-07T21:02:00.000Z"
}
}
Şema
id: number
nokta tanımlayıcısı
örnek: 1764
updatedDate: string
noktanın değiştirilme tarihi
version: number
noktanın sürüm numarası
örnek: 10
identifier: string
alan kaydı için metinsel tanımlayıcı
örnek: catalog
varsayılan: marker
attributeSetId: number
kullanılan özellik setinin tanımlayıcısı
örnek: 7
formData: FormDataLangType
formdan gönderilen veri
örnek:
{
"en_US": [
{
"marker": "marker_1",
"value": "Ad"
}
]
}
notificationData: UserNotificationDataType
kullanıcıyı bilgilendirmek için veri
örnek:
{
"email": "test@test.zone",
"phonePush": "",
"phoneSMS": "+19991234567"
}
systemCode: string
sahip olduğu resmi işlemleri gerçekleştirmek için sistem kodu (şifre sıfırlama, aktivasyon)
örnek:
{
"value": "90BDCX",
"expiredDate": "2024-05-07T21:02:00.000Z"
}
formIdentifier: string
yetkilendirme sağlayıcısının formunun metin tanımlayıcısı
örnek: reg_form
authData: FormAuthDataType
yetkilendirme sağlayıcısına bağlı formdan alınan yetkilendirme verisi
örnek:
[
{
"marker": "login",
"value": "test"
},
{
"marker": "password",
"value": "12345"
}
]
authProviderId: number
yetkilendirme sağlayıcısının ID'si
örnek: 1