Configurações

API

Como cadastrar contatos ou importar um arquivo através da API

Através da integração com nossa API é possível trazer os contatos do sistema que utiliza para dentro da sua conta do Dinamize Automation ou Dinamize .


Documentação de API


A documentação oficial da API está disponível no endereço: https://mail2easypro.com/apidoc/ 



Gerando um token de autenticação


Inicialmente, você deverá gerar um token de aplicação para autenticar-se no sistema.

Para concluir essa etapa, pode seguir esse guia: https://help.dinamize.com/article/4000128088-como-gerar-token-de-autenticacao-com-o-postman


Cadastrar contatos


O link da requisição está disponível em: https://mail2easypro.com/apidoc/#api-4ContactGroup-ContactAdd


Utilizando a chamada abaixo, vamos cadastrar um contato manualmente na sua conta.


curl --header 'Content-Type: application/json; charset=utf-8' --header 'auth-token: #.######.##.##########################' --data '{  "email":"test@test.com",  "name":"test name",  "contact-list_code":"1"}' https://api.dinamize.com/emkt/contact/add


Observe a requisição na figura: 





Os parâmetros listados abaixo representam os dados da chamada que estamos executando:


emaile-mail do contato.

name:  Nome do contato.

contact-list_code: Código da lista que estamos trabalhando.


Poderiam ainda cadastrar dados em campos adicionais utilizando o custom_fields: Campos personalizados (cmp4, cmp5, cmp6...).




Após executar o código, temos a resposta abaixo:



O contato foi então criado dentro da lista.



Importar contatos


Caso precisem adicionar uma grande quantidade de contatos, utilize a chamada de importação.


O link da requisição está disponível em: https://mail2easypro.com/apidoc/#api-5ContactImportGroup-ContactImportAdd


Utilize a chamada abaixo para realizar a importação de uma planilha de contatos.


curl --header 'Content-Type: multipart/form-data' --header 'auth-token: #.######.##.##########################' -F 'file=@/arquivo.csv' -F 'command=import' -F 'parameters={"contact-list_code": "1", "separator": ";", "header": false, "file_columns": [{"Position":"0", "Field":"1", "Rule":"3"}, {"Position":"1", "Field":"2", "Rule":"3"}, {"Position":"2", "Field":"4", "Rule":"3", "Extras": {"separator":",", "action":"increment", "include_new_values":true} } ] }' http://api.dinamize.com/emkt/contact




Depois de importar a requisição, troque no Body o command de Text para File e selecione seu arquivo.






Os parâmetros listados abaixo representam os dados da chamada que estamos executando:


command: Nome do comando

parameters: Parâmetros da chamada

file: Arquivo CSV, TXT, XLS, XLSX ou ZIP

contact-list_code: Código da lista de contatos

separator: Define o separador dos dados do arquivo (; ou ,)

header: Define se a primeira linha é um cabeçalho (true) ou um contato (false)

file_columns: Define posição da coluna (a primeira da planinha é a 0), campo da conta a ser associado e regras para cada coluna (

Position: Define a posição da coluna no arquivo

Field: Código do campo

Rule: Regra para sobrescrever dados (1-Não sobrescrever, 2-Sobrescrever apenas se vazio, 3-Sempre sobrescrever, 4-Não sobrescrever se arquivo vazio)

Extras (opcional): Informações extras (utilizado em campos multi-valor, campos do tipo data e campos do tipo telefone) [obrigatório para utilizar o campo telefone]


Extras


action (opcional): Define regra para substituição de dados (increment,decrement,replacement)

separator (opcional): Define o separador do campo multi-valor

include_new_values (opcional): Define se é para inserir valores desconhecidos (true ou false)

format (opcional): Define o formato do campos data/hora [AAAA/MM/DD , D/M/A, M/D/A, D/M, M/A] - [THH:MI:SS , HH:MI:SS , HH:MI:SS am, HH:MI, HH]

ddi: Define o valor do código do país (DDI) padrão que será utilizado para completar o número telefone caso ele não possua um DDI válido para nenhuma região. É fortemente indicado que o número já esteja no formato ddi-ddd-numero [Ex: 5551000000000] (obrigatório apenas para utilizar o campo telefone) [Ex: 55]

ddd: Define o valor do código de área (DDD) padrão que será utilizado para completar o número telefone caso ele não possua um DDD válido para ddi do telefone. É fortemente indicado que o número já esteja no formato ddi-ddd-numero [Ex: 555100000000] (obrigatório apenas para utilizar o campo telefone) [Ex: 51, 11, 21]



Após executar o código, temos a resposta abaixo:



Pronto, dessa forma você consegue cadastrar seus contatos em sua conta ou importar um arquivo com eles.


Acompanhe os principais tutoriais sobre nossa integração API