API - Web to Lead

INFORMAÇÕES IMPORTANTES SOBRE O PROCESSO DE INTEGRAÇÃO COM A PLATAFORMA ATENDARE: WEB TO LEAD

Buscando aumentar a facilidade no processo de Integração com a Plataforma Atendare, este conteúdo irá fornecer as informações necessárias para que a integração ocorra de forma eficiente. Neste sentido é necessário que algumas informações estejam no formato correto e exigido pela API do Atendare.

No decorrer desta documentação são apresentadas informações sobre os métodos e objetos utilizados para a Integração.

Endpoint da API:

Toda a comunicação é realizada através do formato JSONO endereço (endpoint) da API é o seguinte:

https://app.atendare.com/Marketing/api/WebToLeadApi

Autenticação

Para realizar a autenticação da sua empresa com a API você deve seguir os seguintes procedimentos:
Authorization é a chave de acesso a API. Essa chave é fornecida pela equipe do Atendare. Ele deve ser passado como parâmetro no ‘Header’ da requisição POST. 

MÉTODO HTTP POST
Authorization = 'Basic' + SuaChave

Retorno

Se ocorreu tudo corretamente você receberá um retorno:

HTTP RESPONSE CODE: 200 (OK)
RESPONSE CONTENT: true


Classe: Lead

Representa um lead, abaixo a tabela que apresenta as propriedades existentes neste objeto.

Propriedade
Tipo
Tamanho
(caracteres)
Descrição
Name
string
200
Nome do lead
Email
string
200
E-mail do lead
Phone
string
20
Telefone do lead
Birthdate
DateTime

Data de nascimento do lead no fomato: yyyy-mm-dd
Notes
string

Notas e Observações
FormToken
string

Chave secreta do Atendare (fornecida pela nossa equipe)
ListAddress
List<Address>

Lista de endereços do lead
ListField
List<Field>

Lista de campos personalizados
OptinEmail
int

Define se o lead aceita receber e-mails promocionais
0 = Indiferente (Padrão)
1 = Aceita
2 = Não Aceita
StageId
long
20
Define o estágio do lead. O código é fornecido por nossa equipe. Se não informado assume o estágio "Em Aberto".
Company
LeadCompany

Se informado, relaciona uma empresa ao lead.


Exemplo

{
Name: 'Nome do Lead',
Email: 'lead@atendare.com',
Phone: '(55)35358128',
Birthdate: '2011-02-11',
Notes: 'Lead de Exemplo para a Documentação',
FormToken: '***************',
OptinEmail: 0,
StageId: 1,
Company: {
Name: 'Empresa do Lead',
FormToken: '***************'
},
ListAddress: [
{
Country: 'Brasil'
}
],
ListField: [
{
Token: '************',
Value: 'CEO'
},
{
Token: '************',
Value: 'Já uso o Atendare'
}
]
}


Classe: LeadCompany

Representa a empresa de um lead, abaixo a tabela que apresenta as propriedades existentes neste objeto.

Propriedade
Tipo
Tamanho
(caracteres)
Descrição
Name
string
200
Nome da empresa
Email
string
200
E-mail da empresa
Phone
string
200
Telefone da empresa
FoundationDate
DateTime

Data de fundação da empresa no formato yyyy-mm- dd.
Notes
string

Notas e Observações
FormToken
string

Chave secreta do Atendare (fornecida pela nossa equipe)
ListAddress
List<Address>

Lista de endereços da empresa
ListField
List<Field>

Lista de campos personalizados
OptinEmail
int

Define se o lead aceita receber e-mails promocionais
0 - Indiferente (Padrão)
1 - Aceita
2 - Não Aceita


Exemplo

{
Name: 'Empresa do Lead',
Email: 'empresadolead@atendare.com',
Phone: '(55)35358128',
Birthdate: '2011-02-11',
Notes: 'Empresa do Lead de Exemplo para a Documentação',
FormToken: '***************',
OptinEmail: 0,
ListAddress: [
{
Country: 'Brasil',
State: 'RS',
City: 'Três de Maio',
Neighborhood: 'Centro',
PostalCode: '98910-000',
AccountAddress: 'Av. Uruguai',
Number: '513',
Complement: 'Sala 201',
Prefered: true,
Type: 3
}
],
ListField: [
{
Token: '************',
Value: 'Micro-empresa'
}
],
}


Classe: Address

Representa um endereço de um lead, abaixo a tabela que apresenta as propriedades existentes neste objeto.

Propriedade
Tipo
Tamanho
(caracteres)
Descrição
Country
string
100
País
State
string
100
Estado
City
string
100
Cidade
Neighborhood
string
100
Bairro
PostalCode
string
15
Código Postal (CEP)
AccountAddress
string
200
Endereço
Number
string
20
Número
Complement
string
100
Complemento
Prefered
bool

Define se o endereço é o principal:
True - principal
False - secundário
* É recomendado ter somente um endereço principal
Type
int

Define o tipo de endereço:
1 – Endereço Residencial
2 – Endereço de Entrega
3 – Endereço Comercial
4 – Endereço de Cobrança


Exemplo

{
Country: 'Brasil',
State: 'RS',
City: 'Três de Maio',
Neighborhood: 'Centro',
PostalCode: '98910-000',
AccountAddress: 'Av. Uruguai',
Number: '513',
Complement: 'Sala 201',
Prefered: true,
Type: 3
}


Classe: Field

Representa um campo personalizado de um lead, abaixo a tabela que apresenta as propriedades existentes neste objeto.

Propriedade
Tipo
Tamanho
(caracteres)
Descrição
Token
string
200
Chave secreta do campo personalizado (fornecida pela nossa equipe)
OBRIGATÓRIO
Value
string

Informação do campo personalizado


Exemplo

{
Token: '************',
Value: 'Micro-empresa'
}


Suporte

Caso houver algum problema, restarem dúvidas ou precisa de ajuda, contate o suporte através do e-mail suporte@atendare.com