Ana içeriğe geç

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 nesne 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", // E-posta bildirimleri alanı. Gereklidir.
  "phonePush": [
    "+99999999999"
  ],                                 // Push bildirimleri alanı. İsteğe bağlı.
  "phoneSMS": "+99999999999"         // SMS bildirimleri alanı. İsteğe bağlı.
}

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

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

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

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 nitelik ile örnek​

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 nitelik ile örnek​

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 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 nitelik ile örnek​

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 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);

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

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 nitelik (iç içe liste) ile örnek​

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​

{
  "createdDate": "2025-12-26T12:17:46.115Z",
  "deletedAt": null,
  "formData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "f-name",
      "value": "İkinci isim"
    }
  ],
  "id": 286,
  "identifier": "user_email@gmail.com",
  "isActive": false,
  "isDeleted": false,
  "locale": "en_US",
  "notificationData": {
    "email": "user_email@gmail.com"
  },
  "email": "user_email@gmail.com",
  "state": {},
  "updatedDate": "2025-12-26T12:17:46.115Z",
  "version": 0
}

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

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
Kayıt varlığı ile ilişkili yerel veya dil kodu.
örnek: "en_US"