signUp

Kullanıcı kaydı (❗️Kullanıcı aktivasyonu gerektiren sağlayıcılar için, bir aktivasyon kodu ilgili kullanıcı bildirim yöntemiyle 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*,
formIdentifier*,
langCode,
formData
);

Parametreler şeması

Şema

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

body(required): 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(required): string
Kayıt formunun tanımlayıcısı.
örnek: "reg"

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

body.formData(required): IAuthFormData | IAuthFormData[]
Kayıt için form verisi, tek bir nesne veya nesneler dizisi olabilir.
örnek:

{
  "marker": "last_name",
  "type": "string",
  "value": "Name"
}

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

formData.type(required): string
Form alanının türü, 'string', 'email' vb. gibi.
örnek: "string"

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

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

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

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 örnek.

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

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

"date", "dateTime", "time" türleri ile örnek

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": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

"text" türünde nitelik ile örnek

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "text",
      "value": {
        "htmlValue": "<p>Bu benim</p>",
        "plainValue": "",
        "params": {
          "isEditorDisabled": false,
          "isImageCompressed": true
        }
      }
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

"textWithHeader" türünde nitelik ile örnek

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "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"
  }
};

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

"image" ve "groupOfImages" türünde nitelik ile örnek

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "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"
  }
};

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

"file" türünde nitelik ile örnek

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "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"
  }
};

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

"radioButton" ve "list" türünde nitelik ile örnek

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "list",
      "value": [
        {
          "title": "kırmızı",
          "value": "1",
          "extended": {
            "value": "red",
            "type": "string"
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

"entity" türünde nitelik (iç içe liste) ile örnek

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "entity-selector",
      "type": "entity",
      "value": [
        {
          "id": "1",
          "title": "kırmızı",
          "value": "1",
          "parentId": "null"
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

Tek bir push tanımlayıcı ile örnek

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "list",
      "value": [
        {
          "title": "kırmızı",
          "value": "1",
          "extended": {
            "value": "red",
            "type": "string"
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

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

Birden fazla push tanımlayıcı ile örnek

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "list",
      "value": [
        {
          "title": "kırmızı",
          "value": "1",
          "extended": {
            "value": "red",
            "type": "string"
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.zone",
    "phonePush": [],
    "phoneSMS": "+19991234567"
  }
};

const response = 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 ekli form verisi

authData:
yetkilendirme sağlayıcısına ekli formdan alınan yetkilendirme verisi
örnek:

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

notificationData:
kullanıcı bildirim verisi

attributeSetId: number
kullanılan nitelik setinin tanımlayıcısı
örnek: 7

formData: FormDataLangType
formdan gönderilen veri
örnek:

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

notificationData: UserNotificationDataType
kullanıcıyı bilgilendirmek için veri
örnek:

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

systemCode: string
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öner.

Örnek yanıt

{
  "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 isim"
    }
  ],
  "notificationData": {
    "email": "test@test.com",
    "phonePush": ["+999999999"],
    "phoneSMS": "+9999999999"
  },
  "systemCode": {
    "value": "90BDCX",
    "expiredDate": "2024-05-07T21:02:00.000Z"
  }
}

Yanıt şeması

Şema: ISignUpEntity

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

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

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

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

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

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

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

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

signUp

Açıklama​

Parametreler şeması​

Örnekler​

Minimal örnek​

Basit türler formData "string", "integer", "float" ile örnek.​

"date", "dateTime", "time" türleri ile örnek​

"text" türünde nitelik ile örnek​

"textWithHeader" türünde nitelik ile örnek​

"image" ve "groupOfImages" türünde nitelik ile örnek​

"file" türünde nitelik ile örnek​

"radioButton" ve "list" türünde nitelik ile örnek​

"entity" türünde nitelik (iç içe liste) ile örnek​

Tek bir push tanımlayıcı ile örnek​

Birden fazla push tanımlayıcı ile örnek​

Örnek yanıt​

Yanıt şeması​