1. Ajuda
  2. Como trabalhar via API com sender-solutions.com
  3. 9. Descrição da requisição API: criação de um assinante com confirmação da intenção de assinatura

9. Descrição da requisição API: criação de um assinante com confirmação da intenção de assinatura

9. Descrição da requisição API: criação de um assinante com confirmação da intenção de assinatura

O método é destinado à criação de um novo assinante no projeto com confirmação da assinatura pelo próprio assinante. Isso é adequado para formulários públicos de assinatura em sites, onde é possível inserir qualquer Email. O sistema Sender Solutions enviará a esse assinante um e-mail para que ele confirme separadamente que quer receber o envio. Isso protegerá a base de assinantes de erros acidentais ou intencionais na inserção do Email. Os dados são transmitidos no formato application/json.

Requisição HTTP
  • URL: https://sender-solutions.com/api/subscribers/subscribe-action/
  • Método HTTP: POST
  • Content-Type: application/json
Corpo da requisição (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"
}
Exemplo de requisição usando cURL

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"
}'
Descrição dos campos
Campo Tipo Obrigatório Descrição
Subscriber.Base.Id number Identificador da Base de assinantes. Obrigatoriamente deve ser indicado este campo, ou Subscriber.Base.Name. Se forem transmitidos valores não vazios em ambos os campos, a prioridade é dada a Subscriber.Base.Id
Subscriber.Base.Name string Nome da Base de assinantes. Obrigatoriamente deve ser indicado este campo, ou Subscriber.Base.Id. Se forem transmitidos valores não vazios em ambos os campos, a prioridade é dada a Subscriber.Base.Id
Subscriber.IsActive boolean Indicador de atividade do assinante. Após a confirmação da assinatura, o assinante ficará ativo. É possível ignorar este campo.
Subscriber.Email string Email do assinante
Subscriber.FirstName string Nome
Subscriber.LastName string Sobrenome
Subscriber.Gender string Sexo do assinante. Valores possíveis: "male" para masculino, "female" para feminino, ""(string vazia) para o valor "Não indicado". Por padrão "Não indicado"
Subscriber.Phone string Número de telefone
Subscriber.Tags array[string] Tags do assinante, array de strings
Subscriber.ClientUserId string ID do assinante no sistema do cliente
Subscriber.CustomField1 string Campo livre 1, preencha com qualquer informação a seu critério.
Subscriber.CustomField2 string Campo livre 2, preencha com qualquer informação a seu critério.
Subscriber.CustomField3 string Campo livre 3, preencha com qualquer informação a seu critério.
Subscriber.Address.Country string Código do país de dois caracteres (ISO 3166-1 alpha-2)
Subscriber.Address.City string Cidade
Subscriber.Address.State string | null Região / estado / província
Subscriber.Address.Zip number Código postal
Subscriber.Address.Line1 string Linha principal do endereço
Subscriber.Address.Line2 string Linha adicional do endereço
Subscriber.Address.Line3 string | null Linha adicional do endereço
Subscriber.Birthday string (YYYY-MM-DD) Data de nascimento no formato YYYY-MM-DD
PreferredLanguage string Código do idioma preferido para uso no e-mail ao assinante no formato ISO 639-1. Deve conter 2 letras latinas minúsculas (por exemplo: en, uk, ru). Por padrão en
Exemplo de resposta bem-sucedida. Receber uma resposta bem-sucedida significa que ao assinante foi enviado um e-mail com a confirmação da assinatura. Ele deve seguir o link do e-mail e confirmar a intenção de assinatura.
{
    "success": true
}