Sender Solutions | API isteğinin açıklaması: abonelik niyetinin onaylanmasıyla abone oluşturma

Metot, projede abonenin kendisi tarafından aboneliğin onaylanmasıyla yeni bir abone oluşturmak için tasarlanmıştır. Bu, herhangi bir Email'in girilebildiği sitelerdeki herkese açık abonelik formları için iyi uygundur. Sender Solutions sistemi, böyle bir aboneye, gönderim almak istediğini ayrıca onaylaması için bir e-posta gönderir. Bu, abone tabanını Email girişindeki kazara veya kasıtlı hatalardan korur. Veriler application/json formatında iletilir.

HTTP isteği

URL: https://sender-solutions.com/api/subscribers/subscribe-action/
HTTP metodu: POST
Content-Type: application/json

İsteğin gövdesi (JSON)

{
    "Subscriber": {
        "Base": {
            "Id": 0,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastName": "Catstone",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId3",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        }
    },
    "PreferredLanguage": "uk"
}

cURL kullanılarak istek örneği


curl --location 'https://sender-solutions.com/api/subscribers/subscribe-action/' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{api-token}}' \
--data-raw '{
    "Subscriber": {
        "Base": {
            "Id": 0,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastName": "Catstone",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId3",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        }
    },
    "PreferredLanguage": "uk"
}'

Alanların açıklaması

Alan	Tür	Açıklama
`Subscriber.Base.Id`	number	Abone Tabanının tanımlayıcısı. Bu alan veya Subscriber.Base.Name zorunlu olarak belirtilmelidir. Her iki alana da boş olmayan değerler iletilirse, öncelik Subscriber.Base.Id'ye verilir
`Subscriber.Base.Name`	string	Abone Tabanının adı. Bu alan veya Subscriber.Base.Id zorunlu olarak belirtilmelidir. Her iki alana da boş olmayan değerler iletilirse, öncelik Subscriber.Base.Id'ye verilir
`Subscriber.IsActive`	boolean	Abonenin etkinlik bayrağı. Aboneliğin onaylanmasından sonra abone etkin olacaktır. Bu alanı yok sayabilirsiniz.
`Subscriber.Email`	string	Abonenin Email'i
`Subscriber.FirstName`	string	Ad
`Subscriber.LastName`	string	Soyad
`Subscriber.Gender`	string	Abonenin cinsiyeti. Olası değerler: erkek için "male", kadın için "female", "Belirtilmemiş" değeri için ""(boş dize). Varsayılan olarak "Belirtilmemiş"
`Subscriber.Phone`	string	Telefon numarası
`Subscriber.Tags`	array[string]	Abonenin etiketleri, dize dizisi
`Subscriber.ClientUserId`	string	Müşterinin sistemindeki abone ID'si
`Subscriber.CustomField1`	string	Serbest alan 1, kendi takdirinize göre herhangi bir bilgiyle doldurun.
`Subscriber.CustomField2`	string	Serbest alan 2, kendi takdirinize göre herhangi bir bilgiyle doldurun.
`Subscriber.CustomField3`	string	Serbest alan 3, kendi takdirinize göre herhangi bir bilgiyle doldurun.
`Subscriber.Address.Country`	string	İki karakterli ülke kodu (ISO 3166-1 alpha-2)
`Subscriber.Address.City`	string	Şehir
`Subscriber.Address.State`	string \| null	Bölge / eyalet / il
`Subscriber.Address.Zip`	number	Posta kodu
`Subscriber.Address.Line1`	string	Adresin ana satırı
`Subscriber.Address.Line2`	string	Adresin ek satırı
`Subscriber.Address.Line3`	string \| null	Adresin ek satırı
`Subscriber.Birthday`	string (YYYY-MM-DD)	YYYY-MM-DD formatında doğum tarihi
`PreferredLanguage`	string	Aboneye gönderilecek e-postada kullanılacak tercih edilen dilin ISO 639-1 formatındaki kodu. 2 küçük Latin harfi içermelidir (örneğin: en, uk, ru). Varsayılan olarak en

Başarılı yanıt örneği. Başarılı bir yanıt alınması, aboneye aboneliğin onaylanmasına ilişkin bir e-posta gönderildiği anlamına gelir. Onun e-postadaki bağlantıya geçmesi ve abonelik niyetini onaylaması gerekir.

{
    "success": true
}

9. API isteğinin açıklaması: abonelik niyetinin onaylanmasıyla abone oluşturma