\Integrao de Funcionalidades do sistema

Todas as transaes devem seguir o padro abaixo:

Envio de uma requisio POST para o endereo:
http://api.akna.com.br/emkt/int/integracao.php
Com os seguintes campos:
User = E-mail do usurio
Pass = Senha do usurio criptografada com MD5
Client = Cdigo da empresa no sistema, se o usurio s faz parte de uma empresa o
campo no obrigatrio
XML = Contedo da Solicitao
Ateno: O sistema faz diferenciao entre letras maisculas e minsculas por
tanto mantenha User, Pass e XML exatamente como escrito aqui.

Todas as transaes retornam um XML, e no caso de erro de pedido incorreto, alguns padres
de cdigos de retorno so respeitados para todos os tipos de transaes, so eles.
01 = Usurio e/ou senha invlidos
02 = Permisso Negada
03 = Transao Invlida
05 - Usurio pertence a mais de uma empresa, obrigatorio envio de cdigo de
empresa
06 - Acesso negado

ATENO:

Os campos que esto em preto no XML so obrigatrios e o XML deve ser
enviado codificado em UTF-8.

No so aceitos smbolos HTML tais como " ã ç e etc...
exceo do & - nestes casos o texto deve conter a acentuao
normalmente ( ) e reforando, o XML deve estar codificado em UTF-8.

01) Controle de usurios e equipes

01.10) Cria um novo usurio

Envio:
<main>
<func trans="01.10">
<dados_usuario>
<email>[E-MAIL]</email>
<nome>[NOME]</nome>
<senha>[SENHA]</senha>
<confirma_senha>[SENHA]</confirma_senha>
<equipe codigo=[99]>[NOME_EQUIPE]</equipe>
<documento>[DOCUMENTO]</documento>
<idioma>[pt-br/es/en]</idioma>
<telefone>[TELEFONE]</telefone>
<tel_movel>[TELEFONE]</tel_movel>
<supervisor>[S/N]</supervisor>
<acesso_nivel_inferior>[S/N]</acesso_nivel_inferior>
</dados_usuario>
<seguranca>
<restricao_ip>[S/N]</restricao_ip>
<ip_restrito>[999.999.999.999];(...)</ip_restrito>
<data_bloqueio>[AAAA-MM-DD]</data_bloqueio>
<acesso_admin>[S/N]</acesso_admin>
</seguranca>
</func>
</main>

Equipe: O valor dessa chave dever ser obtido com a integrao 01.22. O cdigo da
equipe s dever ser passado quando no for utilizar o caminho completo da equipe
ao utiliza-lo no deve-se passar valor algum entre as chaves equipe, ou seja,
pode-se utilizar apenas uma opo por vez.
IP Restrito: deve-se obrigatriamente passar os ips separados por ';' (ponto e
vrgula)

Retorno:
<main>
<func trans="01.10" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</func>
</main>

01.13) Editar um usurio

Envio:
<main>
<func trans="01.13">
<dados_usuario>
<email>[E-MAIL]</email>
<nome>[NOME]</nome>
<senha>[SENHA]</senha>
<confirma_senha>[SENHA]</confirma_senha>
<equipe codigo=[99]>[NOME_EQUIPE]</equipe>
<documento>[DOCUMENTO]</documento>
<idioma>[pt-br/es/en]</idioma>
<telefone>[TELEFONE]</telefone>
<tel_movel>[TELEFONE]</tel_movel>
<supervisor>[S/N]</supervisor>
<acesso_nivel_inferior>[S/N]</acesso_nivel_inferior>

</dados_usuario>
<seguranca>
<restricao_ip>[S/N]</restricao_ip>
<ip_restrito>[999.999.999.999];(...)</ip_restrito>
<data_bloqueio>[AAAA-MM-DD]</data_bloqueio>
<acesso_admin>[S/N]</acesso_admin>
</seguranca>
</func>
</main>

Equipe: O valor dessa chave dever ser obtido com a integrao 01.22. O cdigo da
equipe s dever ser passado quando no for utilizar o caminho completo da equipe
ao utiliza-lo no deve-se passar valor algum entre as chaves equipe.
IP Restrito: deve-se obrigatriamente passar os ips separados por ';' (ponto e
vrgula)

Retorno:
<main>
<func trans="01.13" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</func>
</main>

01.15) Excluir um usurio

Envio:
<main>
<func trans="01.15">
<dados_usuario>
<email>[E-MAIL]</email>
</dados_usuario>
</func>
</main>

Retorno:
<main>
<func trans="01.15" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</func>
</main>

01.20) Criar uma nova equipe

Envio:
<main>
<func trans="01.20">
<equipe>
<nome>[NOME_EQUIPE]</nome>
<criar_estrutura>[TRUE]</criar_estrutura>
</equipe>
</func>
</main>

Nome: O valor dessa chave dever seguir o formato de retorno conforme a

integrao 01.22, passando-se o nome da nova equipe no final da estrutura.
Criar Estrutura: Se for passado TRUE neste valor o sistema ir criar toda a
estrutura necessria para a criao da equipe.

Retorno:

<main>
<func trans="01.20" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</func>
</main>

01.22) Lista todas as equipes cadastradas

Envio:
<main>
<func trans="01.22">
</func>
</main>

Retorno:
<main>
<func trans="01.22" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<EQUIPE CODIGO="1">Equipe 1</EQUIPE>
<EQUIPE CODIGO="2" EQUIPE_SUPERIOR="1">Equipe 1|Equipe 1.1</EQUIPE>
<EQUIPE CODIGO="3" EQUIPE_SUPERIOR="2">Equipe 1|Equipe 1.1|Equipe
1.1.1</EQUIPE>
(...)
</func>
</main>

01.23) Edita uma equipe.

Envio:
<main>
<func trans="01.23">
<equipe>
<nome>[NOME_EQUIPE]</nome>
<novo_nome>[NOVO_NOME_EQUIPE]</novo_nome>
<criar_estrutura>[TRUE]</criar_estrutura>
</equipe>
</func>
</main>

Nome: O valor dessa chave dever seguir o formato de retorno conforme a

integrao 01.22, passando-se o caminho completo da equipe.
Novo Nome: O valor dessa chave dever seguir o formato de retorno conforme a
integrao 01.22, passando-se o novo nome da nova equipe no final da estrutura.
Criar Estrutura: Se for passado TRUE neste valor o sistema ir criar toda a
estrutura necessria para a alterao da equipe.
EX:
Se tivermos uma equipe com o caminho como o descrito a seguir:
Equipe1|Equipe1.1|Equipe1.1.1
E quisermos alterar a equipe Equipe1.1.1 para:
Equipe2|Equipe2.1
E no existir uma equipe chamada Equipe2 e desejamos cri-la no processo.
Ento o xml dever ser como o descrito abaixo:
<main>
<func trans="01.23">
<equipe>
<nome>Equipe1|Equipe1.1|Equipe1.1.1</nome>
<novo_nome>Equipe2|Equipe2.1</novo_nome>
<criar_estrutura>TRUE</criar_estrutura>
</equipe>
</func>
</main>
Depois da operao correr com sucesso a estrutura ficar como a descrita
abaixo:
Equipe1|Equipe1.1
Equipe2|Equipe2.1

Retorno:
<main>
<func trans="01.23" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</func>
</main>

01.25) Apaga uma equipe.

Envio:
<main>
<func trans="01.25">
<equipe>
<nome>[NOME_EQUIPE]</nome>
</equipe>
</func>
</main>

Nome: O valor dessa chave dever seguir o formato de retorno conforme a

integrao 01.22, passando-se o caminho completo da equipe.
Para excluir a equipe no pode existir nenhuma equipe relacionada ela, e tambem
nenhum usurio cadastrado nela.
Somente ser excluido a ltima equipe passada.
EX:
Se quisermos excluir a equipe Equipe1.1 do caminho descrito a seguir:
Equipe1|Equipe1.1|Equipe1.1.1
Ser necessrio primeiro a excluso da Equipe1.1.1 e depois da equipe
Equipe1.1, ou seja ser necessrio duas integraes distintas para obter o
resultado esperado.

Retorno:
<main>
<func trans="01.25" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</func>
</main>

11) Controle de Lista de endereos (contatos)

11.01) Consulta as informaes de um contato em uma lista especfica

Envio:
<main>
<emkt trans="11.01">
<lista>[TITULO DA LISTA]</lista>
<contato>[E-MAIL ou CODIGO EXTERNO]</contato>
</emkt>
</main>
Contato: Deve ser informado o e-mail ou cdigo externo. Caso tenha certeza que o
contato existe na lista, mas a integrao retorna que o contato no foi
encontrado, verifique se o ndice da lista est de acordo com o tipo de
informao passada no campo do contato.

Retorno:
<main>
<emkt trans="11.01">
<contato codigo="[CODIGO]">
<nome>[NOME]</nome>
<sequencia>[SEQUENCIA]</sequencia>
<email>[EMAIL]</email>
<sexo>[SEXO]</sexo>
<idade>[IDADE]</idade>
<data_nascimento>[DATA_NASCIMENTO]</data_nascimento>
<endereco>[ENDERECO]</endereco>
<complemento>[COMPLEMENTO]</complemento>
<bairro>[BAIRRO]</bairro>
<cidade>[CIDADE]</cidade>
<estado>[ESTADO]</estado>
<pais>[PAIS]</pais>
<cep>[CEP]</Cep>
<telefone1>[TELEFONE 1]</telefone1>
<telefone2>[TELEFONE 2]</telefone2>
<telefone3>[TELEFONE 3]</telefone3>
<fax>[FAX]</fax>
<infoadc1 name="[Campo Adicional 1]">[INFO 01]</infoadc1>
<infoadc2 name="[Campo Adicional 2]">[INFO 02]</infoadc2>
<infoadc3 name="[Campo Adicional 3]">[INFO 03]</infoadc3>
<infoadc4 name="[Campo Adicional 4]">[INFO 04]</infoadc4>
<infoadc5 name="[Campo Adicional 5]">[INFO 05]</infoadc5>
<infoadc6 name="[Campo Adicional 6]">[INFO 06]</infoadc6>
<infoadc7 name="[Campo Adicional 7]">[INFO 07]</infoadc7>
<infoadc8 name="[Campo Adicional 8]">[INFO 08]</infoadc8>
<infoadc9 name="[Campo Adicional 9]">[INFO 09]</infoadc9>
<infoadc10 name="[Campo Adicional 10]">[INFO 10]</infoadc10>
<infoadc11 name="[Campo Adicional 11]">[INFO 11]</infoadc11>
<infoadc12 name="[Campo Adicional 12]">[INFO 12]</infoadc12>
<infoadc13 name="[Campo Adicional 13]">[INFO 13]</infoadc13>
<infoadc14 name="[Campo Adicional 14]">[INFO 14]</infoadc14>
<infoadc15 name="[Campo Adicional 15]">[INFO 15]</infoadc15>
<infoadc16 name="[Campo Adicional 16]">[INFO 16]</infoadc16>
<infoadc17 name="[Campo Adicional 17]">[INFO 17]</infoadc17>
<infoadc18 name="[Campo Adicional 18]">[INFO 18]</infoadc18>
<infoadc19 name="[Campo Adicional 19]">[INFO 19]</infoadc19>
<infoadc20 name="[Campo Adicional 20]">[INFO 20]</infoadc20>
<data_validade>[DATA VALIDADE]</data_validade>
</contato>
</emkt>
</main>

11.02) Retornar o nome das listas cadastradas no sistema

Envio:
<main>
<emkt trans="11.02">
</emkt>
</main>

Retorno:
<main>
<emkt trans="01.22" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<LISTA ID="[ID]" INDICE="[E/C]" CONTATOS_VALIDOS="[CONTATOS_VALIDOS]"
ARQUIVADA="[S/N]">[NOME_DA_LISTA]</LISTA>
<LISTA ID="[ID]" INDICE="[E/C]" CONTATOS_VALIDOS="[CONTATOS_VALIDOS]"
ARQUIVADA="[S/N]">[NOME_DA_LISTA]</LISTA>
<LISTA ID="[ID]" INDICE="[E/C]" CONTATOS_VALIDOS="[CONTATOS_VALIDOS]"
ARQUIVADA="[S/N]">[NOME_DA_LISTA]</LISTA>
(...)
</emkt>
</main>
ID: Identificador da lista no sistema.
INDICE: ndice da lista:
E E-mail;
C Cdigo Externo.
CONTATOS_VALIDOS: Quantidade de contatos vlidos na lista.
ARQUIVADA: A lista esta arquivada no momento:
S Sim;
N No.
NOME_DA_LISTA: Ttulo da lista utilizada no sistema.

11.05) Importar contatos em uma lista de contatos

Importa um ou mais contatos para uma lista existente, caso a lista no exista o sistema
cria automaticamente a lista e importa os contatos. Se a quantidade de contatos a ser
importado for muito grande recomendamos o uso da integrao (11.10).
Envio:
<main>
<emkt trans="11.05">
<nome>[NOME DA LISTA]</nome>
<substituir>[S/N]</substituir>
<destinatario codigo="[CODIGO]">
<nome>[NOME]</nome>
<email>[EMAIL]</email>
<sexo>[SEXO]</sexo>
<idade>[IDADE]</idade>
<data_nascimento>[DATA_NASCIMENTO]</data_nascimento>
<empresa>[EMPRESA]</empresa>
<cpf>[CPF]</cpf>
<atividade>[ATIVIDADE]</atividade>
<profissao>[PROFISSAO]</profissao>
<tipoend>[TIPO DE ENDERECO]</tipoend>
<endereco>[ENDERECO]</endereco>
<complemento>[COMPLEMENTO]</complemento>
<bairro>[BAIRRO]</bairro>
<cidade>[CIDADE]</cidade>
<estado>[ESTADO]</estado>
<pais>[PAIS]</pais>
<cep>[CEP]</Cep>
<telefone1>[TELEFONE 1]</telefone1>
<telefone2>[TELEFONE 2]</telefone2>
<telefone3>[TELEFONE 3]</telefone3>
<fax>[FAX]</fax>
<infoadc1>[INFO 01]</infoadc1>
<infoadc2>[INFO 02]</infoadc2>
<infoadc3>[INFO 03]</infoadc3>
<infoadc4>[INFO 04]</infoadc4>
<infoadc5>[INFO 05]</infoadc5>
<infoadc6>[INFO 06]</infoadc6>
<infoadc7>[INFO 07]</infoadc7>
<infoadc8>[INFO 08]</infoadc8>
<infoadc9>[INFO 09]</infoadc9>
<infoadc10>[INFO 10]</infoadc10>
<infoadc11>[INFO 11]</infoadc11>
<infoadc12>[INFO 12]</infoadc12>
<infoadc13>[INFO 13]</infoadc13>
<infoadc14>[INFO 14]</infoadc14>
<infoadc15>[INFO 15]</infoadc15>
<infoadc16>[INFO 16]</infoadc16>
<infoadc17>[INFO 17]</infoadc17>
<infoadc18>[INFO 18]</infoadc18>
<infoadc19>[INFO 19]</infoadc19>
<infoadc20>[INFO 20]</infoadc20>
<data_validade>[DATA VALIDADE]</data_validade>
</destinatario>
<destinatario codigo="[CODIGO]">
(...)
</destinatario>
(...)
</emkt>
</main>
Substituir: O valor padro N (No), mas caso seja informado S (Sim) todos os emails da lista sero removidos antes da importao.
Destinatario.Codigo: O cdigo externo do destinatrio opcional

Retorno:
<main>
<emkt trans="11.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<return id="99">
<EMAIL_INVALIDO>[EMAIL]</EMAIL_INVALIDO>
( )
</return>
</emkt>
</main>

O arquivo de retorno poder eventualmente apresentar uma lista de e-mails que

foram considerados invlidos pelo sistema. A API ir fazer a insero de todos os
e-mails vlidos.

11.10) Importao de arquivo para a lista

Importa um ou mais contatos para uma lista existente a partir de um arquivo, caso a
lista no exista o sistema cria automaticamente a lista e importa os contatos. Essa
importao recomendada para importar muitos contatos em lote.
Envio:
<main>
<emkt trans="11.10">
<nome>[NOME DA LISTA]</nome>
<identificador>[E/C]</identificador>
<duplicidade_codigo_externo>[S/N]</duplicidade_codigo_externo>
<arquivo>[URL DO ARQUIVO]</arquivo>
<separador>[SEPARADOR]</separador>
<acao>[I/S/R]</acao>
<opcoes cabecalho="[S/N]" validar="[S/N]" optin="[S/N]" atualizar="[S/N]" />
<campos>
<nome col="[NUMERO DA COLUNA]" />
<email col="[NUMERO DA COLUNA]" />
<sexo col="[NUMERO DA COLUNA]" />
<idade col="[NUMERO DA COLUNA]" />
<data_nascimento col="[NUMERO DA COLUNA]" />
<codigo_externo col="[NUMERO DA COLUNA]" />
<empresa col="[NUMERO DA COLUNA]" />
<cpf col="[NUMERO DA COLUNA]" />
<atividade col="[NUMERO DA COLUNA]" />
<profissao col="[NUMERO DA COLUNA]" />
<tipoend col="[NUMERO DA COLUNA]" />
<endereco col="[NUMERO DA COLUNA]" />
<complemento col="[NUMERO DA COLUNA]" />
<bairro col="[NUMERO DA COLUNA]" />
<cidade col="[NUMERO DA COLUNA]" />
<estado col="[NUMERO DA COLUNA]" />
<pais col="[NUMERO DA COLUNA]" />
<cep col="[NUMERO DA COLUNA]" />
<telefone1 col="[NUMERO DA COLUNA]" />
<telefone2 col="[NUMERO DA COLUNA]" />
<telefone3 col="[NUMERO DA COLUNA]" />
<fax col="[NUMERO DA COLUNA]" />
<infoadc1 col="[NUMERO DA COLUNA]" />
<infoadc2 col="[NUMERO DA COLUNA]" />
<infoadc3 col="[NUMERO DA COLUNA]" />
<infoadc4 col="[NUMERO DA COLUNA]" />
<infoadc5 col="[NUMERO DA COLUNA]" />
<infoadc6 col="[NUMERO DA COLUNA]" />
<infoadc7 col="[NUMERO DA COLUNA]" />
<infoadc8 col="[NUMERO DA COLUNA]" />
<infoadc9 col="[NUMERO DA COLUNA]" />
<infoadc10 col="[NUMERO DA COLUNA]" />
<infoadc11 col="[NUMERO DA COLUNA]" />
<infoadc12 col="[NUMERO DA COLUNA]" />
<infoadc13 col="[NUMERO DA COLUNA]" />

<infoadc14 col="[NUMERO DA COLUNA]" />

<infoadc15 col="[NUMERO DA COLUNA]" />
<infoadc16 col="[NUMERO DA COLUNA]" />
<infoadc17 col="[NUMERO DA COLUNA]" />
<infoadc18 col="[NUMERO DA COLUNA]" />
<infoadc19 col="[NUMERO DA COLUNA]" />
<infoadc20 col="[NUMERO DA COLUNA]" />
<data_validade col="[NUMERO DA COLUNA]" />
</campos>
</emkt>
</main>
Arquivo: Endereo do arquivo a ser importado, aceita os protocolos HTTP, HTTPS,
FTP e FTPS.
O sistema suporta arquivos nos formatos ZIP, XLS, CSV e Texto. O arquivo no
formato ZIP deve conter somente um arquivo dentro no formato XLS, CSV ou Texto.
Para o arquivo a ser enviado temos o limite de at 20Mb para arquivos ZIP e 40MB
para os outros tipos de arquivos.
Exemplo: ftp://user:senha@ftp.dominio.com.br/pasta/arquivo.zip
Valores para o campo ao
I = Adicionar o contedo do arquivo ao contedo da lista
S = Remover o contedo anterior da lista antes de importar
R = Excluir da lista os contatos importados do arquivo
Todos os campos exceto e-mail so de uso opcional, portanto a omisso de <nome
col="[NUMERO DA COLUNA]" /> por exemplo, pode ser feita sem problemas.

Retorno:
<main>
<emkt trans="11.10" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<processo>[CODIGO MD5]</processo>
</emkt>
</main>

11.11) Consulta a situao de processo de importao da integrao (11.10)

Envio:
<main>
<emkt trans="11.11">
<processo>[CODIGO MD5]</processo>
</emkt>
</main>

Retorno:
<main>
<emkt trans="11.11" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<progresso>[PERCENTUAL]</progresso>
<resultado>
<erro>[MENSAGEM DE ERRO]</erro>
<lista>[NOME DA LISTA]</lista>
<arquivo>[NOME DO ARQUIVO]</arquivo>
<linhas>[LINHAS NO ARQUIVO]</linhas>
<duplicados>[CONTATOS DUPLICADOS NO ARQUIVO]</duplicados>
<inseridos>[CONTATOS INSERIDOS]</inseridos>
<atualizados>[CONTATOS ATUALIZADOS]</atualizados>
<invalidos>[CONTATOS INVALIDOS]</invalidos>
<formato_invalido>[CONTATOS COM E-MAIL ERRADOS]</formato_invalido>
<cadastrados>[CONTATOS J CADASTRADOS]</cadastrados>
<validos_antes>[CONTATOS VALIDOS ANTES DA IMPORTAO]</validos_antes>
<validos_apos>[CONTATOS VALIDOS APS IMPORTAO]</validos_apos>

</resultado>
</emkt>
</main>

11.20) Histrico de aes por perodo

Envio:
<main>
<emkt trans="11.20">
<data_inicial>AAAA-MM-DD HH:MM:SS</data_inicial>
<data_final>AAAA-MM-DD HH:MM:SS</data_final>
<usuario>[E-MAIL DO USURIO]</usuario>
<novas_colunas>[S]</novas_colunas>
</emkt>
</main>
A diferena entre a data inicial e data final no pode ser maior que 24 horas

Retorno:
<main>
<emkt trans="11.20" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<processo>[CODIGO MD5]</processo>
</emkt>
</main>

11.21) Situao do processo de histrico de aes por perodo (11.20)

Envio:
<main>
<emkt trans="11.21">
<processo>[CODIGO MD5]</processo>
</emkt>
</main>

Retorno:
<main>
<emkt trans="11.21" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<progresso>[PERCENTUAL]</progresso>
<resultado>
<erro>[MENSAGEM DE ERRO]</erro>
</resultado>
</emkt>
</main>
Quando o progresso for igual a 100 e no houver mensagem de erro podemos
solicitar a 11.22

11.22) Download do arquivo ZIP solicitado no histrico de aes por perodo (11.20)
Realizar essa transao somente aps a integrao (11.21) retornar o progresso 100%.
Envio:

<main>
<emkt trans="11.22">
<processo>[CODIGO MD5]</processo >
</emkt>
</main>

Retorno:
Essa solicitao retorna um arquivo no formato zip, contendo um
csv com as seguintes colunas Ao, Data e Hora, E-mail, Cdigo
externo, Evento (Descrio), Cdigo do Evento e Elemento. O csv
retornado usar ; (ponto e virgula) como separador dos campos.
Possibilidades de cdigos de eventos
TE Troca de e-mail, o elemento ter os dois e-mails separados
por | (pipe), sendo que o primeiro ser o e-mail anterior e
o segundo o novo e-mail
OO Opt-out, o elemento ser a rea de interesse
OI Opt-in, o elemento ser a rea de interesse
EN Encaminhamento, o elemento ser o e-mail para quem o
usurio encaminhou
ET Entregue, nesse caso no haver contedo em elemento
ER Erro, o elemento ser o erro que ocorreu
VW Visualizou, nesse caso no haver contedo em elemento
CL Clique, o elemento ser o link onde ocorreu o clique
AC Alterao de cadastro, caso no haver contedo em elemento
PR Pedido de remoo, o elemento vir preenchido com o motivo
caso esse tenha sido informado.

11.30) Histrico de erros por perodo

Envio:
<main>
<emkt trans="11.30">
<data_inicial>AAAA-MM-DD HH:MM:SS</data_inicial>
<data_final>AAAA-MM-DD HH:MM:SS</data_final>
</emkt>
</main>
A diferena entre a data inicial e data final no pode ser maior que 24 horas

Retorno:
<main>
<emkt trans="11.30" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<contato>
<data>[AAAA-MM-DD HH:MM:SS]</data>
<email>[EMAIL DO CONTATO]</email>
<acao>[TITULO DA ACAO]</acao>
<evento>[TIPO DE ERRO]</evento>
</contato>
</emkt>
</main>

DATA Data e hora do histrico

EMAIL Email do contato que gerou o histrico

ACAO Titulo da ao que o contato participou
EVENTO - Tipo de erros que podem ser apresentados:
- Anti-Spam
- Contedo indisponvel
- Contedo rejeitado
- Contedo invlido
- Caixa postal cheia
- Erro desconhecido
- Falha de entrega
- Limite de recebimento no perdo
- Destinatrio desconhecido
- Servidor desconhecido
- Caixa postal indisponvel

11.90) Insere opt-out / Opt-in

Envio:
<main>
<emkt trans="11.90">
<acao>[ACAO]</acao> (0 = Opt-out, 1 = Opt-In)
<email>[EMAIL]</email> (E-mail que ser setado opt-out ou opt-in)
<categoria>[CATEGORIA]</categoria>
<categoria>[CATEGORIA]</categoria>
<categoria>[CATEGORIA]</categoria>
(...)
</emkt>
</main>
ACAO:
0 = OPT-OUT;
1 = OPT-IN;
EMAIL E-mail que ser setado para opt-out / opt-in
CATEGORIA Poder conter o ttulo da categoria qual o contato ser setado para
opt-out / opt-in. Tambm poder conter a literal [TODAS] para indicar que a
alterao valer para todas as categorias.

Retorno:
<main>
<emkt trans="11.90" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</emkt>
</main>

Retorno com falha:

<main>
<emkt trans="11.90" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="99">Categoria no encontrada (Lista de categorias separadas por
virgula)</return>
</emkt>
</main>

11.95) Retorna os opt-out do dia

Envio:
<main>
<emkt trans="11.95">

<data>AAAA-MM-DD</data>
</emkt>
</main>

Retorno:
<main>
<emkt trans="11.95" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<contato>
<datahora>[AAAA-MM-DD HH:MM:SS]</datahora>
<email>[EMAIL DO CONTATO]</email>
<acao codigo="[CODIGO DA ACAO]">[NOME DA ACAO]</acao>
<motivo codigo="[CODIGO DO MOTIVO]">[DESCRICAO DO MOTIVO]</motivo>
<area codigo="[CODIGO DA AREA]">[NOME DA AREA DE INTERESSE]</area>
</contato>
<contato>
(...)
</contato>
</emkt>
</main>
Esse processo s considera aes no arquivadas

12) Controle de Mensagens

12.05) Cadastra uma nova categoria no sistema.
Envio:
<main>
<emkt trans="12.05">
<categoria>
<nome>[DESCRICAO]</nome>
</categoria>
</emkt>
</main>

Retorno:
<MAIN>
<EMKT TRANS="12.05" KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<RETURN ID="00">OK</RETURN>
</EMKT>
</MAIN>

12.20) Remove uma categoria do sistema.

Envio:
<main>
<emkt trans="12.20">
<categoria>
<nome>[DESCRICAO]</nome>
</categoria>
</emkt>
</main>

Retorno:
<MAIN>
<EMKT TRANS="12.20" KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<RETURN ID="00">OK</RETURN>
</EMKT>
</MAIN>

12.50) Listar todas as categorias cadastradas.

Envio:
<main>
<emkt trans="12.50">
<categoria>
<nome>[TODAS]</nome>
</categoria>
</emkt>
</main>

Retorno:
<MAIN>
<EMKT TRANS="12.50" KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<CATEGORIA>
<DESCRICAO CODIGO=[CODIGO]>[DESCRICAO]<DESCRICAO>
( )

</CATEGORIA>
</EMKT>
</MAIN>

12.70) Edita uma categoria.

Envio:
<main>
<emkt trans="12.70">
<categoria>
<nome>[DESCRICAO]</nome>
<novo>[NOVA_DESCRICAO]</novo>
</categoria>
</emkt>
</main>

Retorno:
<main>
<emkt trans="12.70" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</emkt>
</main>

15) Controle de Mensagens

15.05) Criao de Mensagem
Envio:
<main>
<emkt trans="15.05">
<nome>[NOME DA MENSAGEM]</nome>
<categoria>[NOME DA CATEGORIA]</categoria>
<idioma>[CDIGO DO IDIOMA]</idioma>
<html>[HTML]</html>
<texto tipo="[P/H/C]">[TEXTO ALTERNATIVO]</texto>
<alternativa>[MENSAGEM DE VISUALIZAO ALTERNATIVA]</alternativa>
<optout>[MENSAGEM DE OPT-OUT]</optout>
<encaminhar>[MENSAGEM DE ENCAMINHAMENTO]</encaminhar>
<msg_redes_sociais>[MENSAGEM REDES SOCIAIS]</msg_redes_sociais>
<redes_sociais>[REDES SOCIAIS]</redes_sociais>
<link url="[LINK]" tipo="[N/P/A/O/E]">[NOME DO LINK]</link>
<link url="[LINK]" tipo="[N/P/A/O/E]">[NOME DO LINK]</link>
(...)
</emkt>
</main>
A mensagem html deve ter os caracteres "<", ">", """ e "&" substitudos por
"&lt;", "&gt;", "&quot;" e "&amp;" respectivamente.
Categoria: a rea de interesse da mensagem
Idioma
pt-br => Portugus, valor padro caso no seja enviado o idioma
en
=> Ingls
es
=> Espanhol
Texto.Tipo
P - Texto padro do sistema
H - HTML da mensagem em formato texto
C - Texto customizado pelo cliente
Link.Tipo
N Normal
P Alterao de dados cadastrais
A Visualizao alternativa
O Solicitao de OptOut
E Encaminhamento de mensagem
Link.Monitorar
Quando link.Tipo for igual a N (normal), podemos opcionalmente monitor-lo.
Informar os cdigos de monitoramento separados por |, conforme lista abaixo:
WA - Web Analytics
GA - Google Analytics
Exemplos
:
<link url="[LINK]" tipo="N monitorar=GA>[NOME DO LINK]</link>
<link url="[LINK]" tipo="N monitorar=GA|WA>[NOME DO LINK]</link>
Link.Anunciante
Link.Anuncio
Os dois atributos devem ser utilizados ao mesmo instante. Somente poder ser
utilizado Anunciantes e Anncios que estejam ativos no sistema.
Exemplos
:
<link url="[LINK]" tipo="N anunciante=NOME_ANUNCIANTE
anuncio=NOME_ANUNCIO>[NOME DO LINK]</link>
Redes sociais, enviar os cdigos das redes desejadas separados por vrgula, segue
abaixo lista de redes disponveis.
DLC
DIG
FCB
FSQ
GBM

=>
=>
=>
=>
=>

Delicious
Digg
Facebook
Fresqui
Google Bookmarks

MNM
MYY
MYS
ORK
TWT
WLV

=>
=>
=>
=>
=>
=>

Mename
My Yahoo
Myspace
Orkut
Twitter
Windows Live

Retorno:
<main>
<emkt trans="15.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</emkt>
</main>

15.07) Envio de e-mail de teste a partir de uma mensagem

Envio:
<main>
<emkt trans="15.07">
<titulo>[NOME DA MENSAGEM]</titulo>
<nome_remetente>[NOME]</nome_remetente>
<email_remetente>[EMAIL]</email_remetente>
<assunto>[ASSUNTO]</assunto>
<email>[EMAIL]</email>
<email>[EMAIL]</email>
( ... )
</emkt>
</main>

Titulo: o titulo da mensagem salva no sistema.

No mnimo um campo email dever ser passado.
O campo email poder ser repetido por no mximo 10 vezes, ou seja somente ser
possivel enviar 10 e-mails de teste por solicitao.

Retorno:
<main>
<emkt trans="19.07" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</emkt>
</main>

15.50) Lista de mensagens cadastradas

Envio:
<main>
<emkt trans="15.50">
<data_inicial>AAAA-MM-DD</data_inicial>
<data_final> AAAA-MM-DD</data_final>
</emkt>
</main>
A data inicial e a data final no so obrigatrios e podem ser informados
separadamente.

Retorno:

<main>
<emkt trans="15.50" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<mensagem>
<titulo>[TITULO DA MENSAGEM]</titulo>
<data>AAAA-MM-DD</data>
</mensagem>
</emkt>
</main>

15.55) Informaes da mensagem

Envio:
<main>
<emkt trans="15.55">
<titulo>[TITULO DA MENSAGEM]</titulo>
</emkt>
</main>

Retorno:
<main>
<emkt trans="15.55" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<mensagem>
<titulo>[TITULO DA MENSAGEM]</titulo>
<data>AAAA-MM-DD</data>
<html>[CONTEUDO DA MENSAGEM]</html>
<texto_alternativo>[TEXTO ALTERNATIVO]</texto_alternativo>
<texto_optout>[TEXTO DA MENSAGEM DE OPTOUT]</texto_optout>
<texto_visalternativa>[TEXTO DA MENSAGEM DE VISUALIZACAO
ALTERNATIVA]</texto_visalternativa>
<texto_encaminhamento>[TEXTO DA MENSAGEM DE
ENCAMINHAMENTO]</texto_encaminhamento>
<texto_altcadastro>[TEXTO DA MENSAGEM DE ALTERAO DE
CADASTRO]</texto_altcadastro>
<anexo>[NOME DO ARQUIVO]</anexo>
<anexo>(...)</anexo>
<link MONITORADO="[S/N]" OPTOUT="[S/N]" VISALTERNATIVA="[S/N]"
ENCAMINHAR="[S/N]" ALTCADASTRO="[S/N]">
<titulo>[TITULO DO LINK]</titulo>
<url>[URL DO LINK]</url>
</link>
<link>
(...)
</link>
</mensagem>
</emkt>
</main>

19) Controle de Campanhas

19.05) Incluso de uma nova ao

Envio:
<main>
<emkt trans="19.05">
<nome>[NOME DA ACAO]</nome>
<mensagem url=true>[NOME OU LINK DA MENSAGEM]</mensagem>
<usuario>[E-MAIL USUARIO]</usuario>
<opcao>
<idioma>[SIGLA DO IDIOMA]</idioma>
<area_interesse>[REA DE INTERESSE]</area_interesse>
<marca_envio>[ENVIAR SOMENTE QUANDO A MENSAGEM CONTIVER]</marca_envio>
</opcao>
<data_encerramento>[AAAA-MM-DD]</data_encerramento>
<nome_remetente>[NOME DO REMETENTE]</nome_remetente>
<email_remetente>[EMAIL DO REMETENTE]</email_remetente>
<email_retorno>[EMAIL PARA RETORNO]</email_retorno>
<assunto>[ASSUNTO]</assunto>
<email_termino>[EMAIL DE TERMINO]</email_termino>
<solicita_motivo>[S/N]</solicita_motivo>
<lista>[NOME DA LISTA]</lista>
<lista>[NOME DA LISTA]</lista>
(...)
<filtro type="avancado">
<grupo tipo="[E/OU]">
<regra campo="[CAMPO]" operador="[TIPO_DE_OPERADOR]" valor1="[VALOR1]"
valor2="[VALOR2]" />
</grupo>
</filtro>
<agendar>
<datahora>YYYY-MM-DD HH:MM:SS</datahora>
</agendar>
</emkt>
</main>

Mensagem: O atributo da URL deve ser indicado como TRUE caso se deseje utilizar
uma URL para o campo mensagem.
Para utilizar uma URL deve-se utilizar o formato abaixo:
<mensagem url="true"><![CDATA[ URL ]]></mensagem>
Quando utilizar URL o campo MARCA_ENVIO obrigatrio.
Usuario: Este campo contm o e-mail do usurio a quem pertence a ao.
Data de Encerramento: a data limite que o sistema vai contabilizar as
informaes (visualizao, cliques, opt-out, etc). O perodo pode ser de 5 dias a
6 meses aps a data de envio.
Nome/E-mail do Remetente: o nome e e-mail exibido como remetente da ao.
E-mail de retorno: o e-mail que aparece quando o contato clica em responder no
seu programa de e-mail.
E-mail de trmino: o e-mail ou lista de e-mails separados por ';' (ponto e
vrgula) que informaro sobre o trmino da ao.
Solicita Motivo: Informa se deve solicitar o motivo de remoo no momento que o
contato faz o opt-out.
Filtro: Para montar um filtro preciso passar pelo menos um grupo com o seu tipo
de operador e uma regra que dever conter, campo, operador e valor(es). Para
lgicas mais precisas, pode ser adicionado um grupo dentro de outro.
Os atributos que devem ser adicionados so:
Grupo: tipo -> E/OU
Regra: campo -> nome do campo(vide abaixo padrao).
operador -> tipo de operador(vide abaixo padrao).
valor1(ou somente valor) -> primeiro ou unico valor desejado.
valor2 -> segundo valor desejado, somente se for preciso usar dois
valores(ex: entre 15 e 20).
Os valores que podem ser passados:
Campo - os nomes dos campos baseado no padro do Email Marketing, seguindo a
nomemenclatura:
email, sexo, idade, data_nascimento, empresa, cpf, atividade, profissao,
tipoend(Tipo de endereo), endereco, complemento, bairro, cidade, estado,
pais, cep, telefone1, telefone2, telefone3, fax, data_validade.
Ou os campos adicionais, seguindo o padro ca1, ca2, ca3, ca20
Operador - lista dos valores que podem ser usados para todos os campos:
igual, diferente, contm, no contm, comea com, termina com.
Com excesso dos seguintes campos, que tem operador(es) unicos:
Sexo:
Estado: , no
Idade e CEP: est entre
Exemplo de uso do filtro
Para montar um filtro com as seguintes regras:
"O email no seja do yahoo.com ou gmail.com, e que tenha de 18 a 25, ou
seja do sexo Feminino, ou que seja de estado de So Paulo, mas que no seja da
cidade de Piracaia"
Esse filtro ser montado da seguinte maneira:
<filtro type="avancado">
<grupo tipo="e">
<regra campo="email" operador="no contm" valor="yahoo.com" />
<regra campo="email" operador="no contm" valor="gmail.com" />
<grupo tipo="ou">
<regra campo="idade" operador="est entre" valor1="18" valor2="25" />
<regra campo="sexo" operador="igual" valor="F" />
<grupo tipo="e">

<regra campo="estado" operador="igual" valor="SP"

/>

<regra campo="cidade" operador="diferente" valor="Piracaia"

/>

</grupo>
</grupo>
</grupo>
</filtro>
Agendar: Tag utilizada para que aps a incluso da ao a mesma seja agendada
para horrio especifcado. A utilizao desta tag equivale a utilizao da
integrao 19.06.
Data/Hora: Data e Hora de envio da ao. Este campo deve ser informado no formato
YYYY-MM-DD HH:MM:SS. Quando a tag Agendar utilizada este campo obrigatrio.

Retorno:
<main>
<emkt trans="19.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</emkt>
</main>

19.06) Agendamento de envio da ao

Envio:
<main>
<emkt trans="19.06">
<titulo>[NOME DA CAMPANHA]</titulo>
<datahora>YYYY-MM-DD HH:MM:SS</datahora>
<prioridade>[PRIORIDADE]</prioridade>
<menosde>[NO ENVIAR EM MENOS DE X HORAS]</menosde>
<totalparcial>[NUMERO DE ENVIOS NO DISPARO]</totalparcial>
<reiniciar>[REINICIAR O ENVIO APS X HORAS]</reiniciar>
<reenvio>[QUANTIDADE DE DIAS PARA O REENVIO PARCIAL]</reenvio>
</emkt>
</main>
Data/Hora: O campo datahora deve ser enviado no formato informado para cancelar
um agendamento feito anteriormente envie 0000-00-00 00:00:00 no campo.
Prioridade: a velocidade de sada dos e-mails, as opes disponveis so:
A
N
B
P

=
=
=
=

Alta
Normal
Baixa
Primeiro envio

Menos de: O campo menosde deve ter o nmero de horas mnimas que o disparo
dever durar. Ao utilizar essa opo, no necessrio enviar o campo prioridade.
Total Parcial: Quantidade de e-mails a ser enviada por disparo.
Reiniciar: Agenda um reenvio dos e-mails restantes aps X horas do ltimo e-mail
enviado no ltimo disparo.
Reenvio: Informa a quantidade de dias para realizar um disparo para os e-mails
que tiveram Falha de entrega e Caixa postal cheia.

Retorno:
<main>
<emkt trans="19.06" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</emkt>
</main>

19.07) Envio de e-mail de teste

Envio:
<main>
<emkt trans="19.07">
<titulo>[NOME DA CAMPANHA]</titulo>
<assunto_teste>[S]</assunto_teste>
<email>[EMAIL]</email>
<email>[EMAIL]</email>
( ... )
</emkt>
</main>

Assunto_teste: Se tiver S neste campo ser inserido o texto "[Teste]" no incio

do assunto da mensagem.
No mnimo um campo email dever ser passado.
O campo email poder ser repetido por no mximo 10 vezes, ou seja somente ser
possivel enviar 10 e-mails de teste por solicitao.

Retorno:
<main>
<emkt trans="19.07" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
</emkt>
</main>

19.10) Estatsticas das aes em um determinado perodo

Envio:
<main>
<emkt trans="19.10">
<datainicial>AAAA-MM-DD HH:MM:SS</datainicial>
<datafinal>AAAA-MM-DD HH:MM:SS</datafinal>
</emkt>
</main>

Retorno:
<main>
<emkt trans="19.10" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<campanha>
<codigo>[CODIGO]</codigo>
<nome>[NOME]</nome>
<email>[REMETENTE]</email>
<destinatario codigo="[CODIGO]" clicado="[S/N]">[EMAIL]</destinatario>
<destinatario codigo="[CODIGO1]" clicado="[S/N]">[EMAIL2]</destinatario>
(...)
</campanha>
<campanha>
(...)

</campanha>
(...)
</emkt>
</main>

19.11) Totais da campanhas

Envio:
<main>
<emkt trans="19.11">
<titulo>[NOME DA CAMPANHA]</titulo>
</emkt>
</main>

Retorno:
<main>
<emkt trans="19.11" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<campanha>
<totaldestinatarios>[TOTAL DE DESTINATARIOS]</totaldestinatarios>
<totalenviado>[TOTAL ENVIADO]</totalenviado>
<totalentregue>[TOTAL ENTREGUE]</totalentregue>
<totalerros>[TOTAL DE ERROS]</totalerros>
<totalvisualizacao>[TOTAL DE VISUALIZAES]</totalvisualizacao>
<totalindicacoes>[TOTAL DE INDICAES]</totalindicacoes>
<totalremocoes>[TOTAL DE PEDIDOS DE REMOO]</totalremocoes>
<totalclicks>[TOTAL DE CLICKS]</totalclicks>
<link>
<titulo>[TITULO DO LINK]</titulo>
<unicos>[TOTAL DE CLICKS UNICOS]</unicos>
<total>[TOTAL DE CLICKS]</total>
</link>
(...)
<erro>
<titulo>[TIPO DE ERRO]</titulo>
<total>[TOTAL DE ERROS]</total>
</erro>
(...)
</campanha>
</emkt>
</main>

19.31) Contatos que visualizaram a campanha

Envio:
<main>
<emkt trans="19.31">
<titulo>[NOME DA CAMPANHA]</titulo>
</emkt>
</main>

Retorno:
<main>
<emkt trans="19.31" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<campanha>
<email>[E-MAIL]</email>
(...)
</campanha>
</emkt>

</main>

19.55) Informaes da ao
Envio:
<main>
<emkt trans="19.55">
<titulo>[TITULO DA AO]</titulo>
</emkt>
</main>

Retorno:
<main>
<emkt trans="19.55" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<acao>
<titulo>[TITULO DA AO]</titulo>
<criacao>AAAA-MM-DD</criacao>
<remetente>
<nome>[NOME DO REMETENTE]</nome>
<email>[E-MAIL DO REMETENTE]</email>
<retorno>[E-MAIL DE RETORNO]</retorno>
</remetente>
<campanha>[CAMPANHA DA AO]</campanha>
<mensagem>
<titulo>[TITULO DA MENSAGEM UTILIZADA]</titulo>
<url>[URL DE ORIGEM DA MENSAGEM]</url>
<html>[CONTEUDO DA MENSAGEM]</html>
<texto_alternativo>[TEXTO ALTERNATIVO]</texto_alternativo>
<texto_optout>[TEXTO DA MENSAGEM DE OPTOUT]</texto_optout>
<texto_visalternativa>[TEXTO DA MENSAGEM DE VISUALIZACAO
ALTERNATIVA]</texto_visalternativa>
<texto_encaminhamento>[TEXTO DA MENSAGEM DE
ENCAMINHAMENTO]</texto_encaminhamento>
<texto_altcadastro>[TEXTO DA MENSAGEM DE ALTERAO DE
CADASTRO]</texto_altcadastro>
<anexo>[NOME DO ARQUIVO]</anexo>
<anexo>(...)</anexo>
<link MONITORADO="[S/N]" OPTOUT="[S/N]" VISALTERNATIVA="[S/N]"
ENCAMINHAR="[S/N]" ALTCADASTRO="[S/N]">
<titulo>[TITULO DO LINK]</titulo>
<url>[URL DO LINK]</url>
</link>
<link>
(...)
</link>
</mensagem>
<area_interesse>[AREA DE INTERESSE]</area_interesse>
<envio>AAAA-MM-DD HH:MM:SS</envio>
<reenvio>AAAA-MM-DD HH:MM:SS</reenvio>
<contatos>
<total>[TOTAL DE CONTATOS DA AO]</total>
<enviado>[TOTAL DE ENVIOS]</enviado>
</contatos>
</acao>
</emkt>
</main>

19.80) Lista de e-mails invlidos da campanha

Envio:
<main>
<emkt trans="19.80">
<titulo>[TITULO DA CAMPANHA]</titulo>

</emkt>
</main>

Retorno:
<main>
<emkt trans="19.80" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<campanha>
<codigo>[CODIGO]</codigo>
<nome>[NOME]</nome>
<email>[REMETENTE]</email>
<destinatario codigo="[CODIGO]">[EMAIL]</destinatario>
<destinatario codigo="[CODIGO1]">[EMAIL2]</destinatario>
(...)
</campanha>
</emkt>
</main>

20) Alteraes de listas das aes

20.01) Incluso de contatos direto em uma ao sem o envio imediato.

Envio:
<main>
<emkt trans="20.01">
<acao>[TITULO DA AO]</acao>
<indice>[E/C]</indice>
<destinatario codigo="[CODIGO]">
<nome>[NOME]</nome>
<email>[EMAIL]</email>
<sexo>[SEXO]</sexo>
<idade>[IDADE]</idade>
<data_nascimento>[DATA_NASCIMENTO]</data_nascimento>
<empresa>[EMPRESA]</empresa>
<cpf>[CPF]</cpf>
<atividade>[ATIVIDADE]</atividade>
<profissao>[PROFISSAO]</profissao>
<tipoend>[TIPO DE ENDERECO]</tipoend>
<endereco>[ENDERECO]</endereco>
<complemento>[COMPLEMENTO]</complemento>
<bairro>[BAIRRO]</bairro>
<cidade>[CIDADE]</cidade>
<estado>[ESTADO]</estado>
<pais>[PAIS]</pais>
<cep>[CEP]</Cep>
<telefone1>[TELEFONE 1]</telefone1>
<telefone2>[TELEFONE 2]</telefone2>
<telefone3>[TELEFONE 3]</telefone3>
<fax>[FAX]</fax>
<infoadc1>[INFO 01]</infoadc1>
<infoadc2>[INFO 02]</infoadc2>
<infoadc3>[INFO 03]</infoadc3>
<infoadc4>[INFO 04]</infoadc4>
<infoadc5>[INFO 05]</infoadc5>
<infoadc6>[INFO 06]</infoadc6>
<infoadc7>[INFO 07]</infoadc7>
<infoadc8>[INFO 08]</infoadc8>
<infoadc9>[INFO 09]</infoadc9>
<infoadc10>[INFO 10]</infoadc10>
<infoadc11>[INFO 11]</infoadc11>
<infoadc12>[INFO 12]</infoadc12>
<infoadc13>[INFO 13]</infoadc13>
<infoadc14>[INFO 14]</infoadc14>
<infoadc15>[INFO 15]</infoadc15>
<infoadc16>[INFO 16]</infoadc16>
<infoadc17>[INFO 17]</infoadc17>
<infoadc18>[INFO 18]</infoadc18>
<infoadc19>[INFO 19]</infoadc19>
<infoadc20>[INFO 20]</infoadc20>
<data_validade>[DATA VALIDADE]</data_validade>
</destinatario>
<destinatario codigo="[CODIGO]">
(...)
</destinatario>
(...)
</emkt>
</main>

ndice:
E = ndice por e-mail
C = ndice por cdigo externo
Todos os campos do destinatrio exceto e-mail so de uso opcional, portanto a
omisso de <nome></nome> por exemplo, pode ser feita sem problemas.
A Ao que ser utilizada no pode ter a data de cancelamento maior do que a data
atual.

Para o envio da ao com os novos endereos cadastrados necessrio chamar a

ao 19.06

Retorno:
<main>
<emkt trans="11.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<return id="99">
<EMAIL_INVALIDO>[EMAIL]</EMAIL_INVALIDO>
( )
<FALHA_INSERIR>[EMAIL]</FALHA_INSERIR>
( )
<EMAIL_OPTOUT MENSAGEM="[MENSAGEM]">[EMAIL]</EMAIL_OPTOUT>
( )
</return>
</emkt>
</main>

O arquivo de retorno poder eventualmente apresentar uma lista de e-mails que

foram considerados invlidos pelo sistema na tag EMAIL_INVALIDO.
Tambm poder ocorrer erro de insero do contato, este tipo de erro ser
retornado na tag FALHA_INSERIR.
Ser feita uma checagem para verificar se o endereo de e-mail passado opt-out
para a rea de interesse desta ao. Caso seja constatado que ele opt-out
para a mesma, ou se ele for para todas as reas de interesses no ser possivel
o envio para este endereo de e-mail. Neste caso o email ser apresentado na tag
EMAIL_OPTOUT e no atributo MENSAGEM ser apresentado a rea de interesse que o
contato opt-out.
Mesmo que ocorrera qualquer um dos erros acima mencionado a API ir fazer a
insero de todos os e-mails vlidos.

20.05) Incluso de contatos direto na ao com agendamento de envio (Aes ondemand)

Envio:
<main>
<emkt trans="20.05">
<acao>[TITULO DA AO]</acao>
<indice>[E/C]</indice>
<envio_minutos>[MINUTOS]</envio_minutos>
<destinatario codigo="[CODIGO]">
<nome>[NOME]</nome>
<email>[EMAIL]</email>
<sexo>[SEXO]</sexo>
<idade>[IDADE]</idade>
<data_nascimento>[DATA_NASCIMENTO]</data_nascimento>
<empresa>[EMPRESA]</empresa>
<cpf>[CPF]</cpf>
<atividade>[ATIVIDADE]</atividade>
<profissao>[PROFISSAO]</profissao>
<tipoend>[TIPO DE ENDERECO]</tipoend>
<endereco>[ENDERECO]</endereco>
<complemento>[COMPLEMENTO]</complemento>
<bairro>[BAIRRO]</bairro>
<cidade>[CIDADE]</cidade>
<estado>[ESTADO]</estado>
<pais>[PAIS]</pais>
<cep>[CEP]</Cep>
<telefone1>[TELEFONE 1]</telefone1>
<telefone2>[TELEFONE 2]</telefone2>
<telefone3>[TELEFONE 3]</telefone3>
<fax>[FAX]</fax>
<infoadc1>[INFO 01]</infoadc1>
<infoadc2>[INFO 02]</infoadc2>

<infoadc3>[INFO 03]</infoadc3>
<infoadc4>[INFO 04]</infoadc4>
<infoadc5>[INFO 05]</infoadc5>
<infoadc6>[INFO 06]</infoadc6>
<infoadc7>[INFO 07]</infoadc7>
<infoadc8>[INFO 08]</infoadc8>
<infoadc9>[INFO 09]</infoadc9>
<infoadc10>[INFO 10]</infoadc10>
<infoadc11>[INFO 11]</infoadc11>
<infoadc12>[INFO 12]</infoadc12>
<infoadc13>[INFO 13]</infoadc13>
<infoadc14>[INFO 14]</infoadc14>
<infoadc15>[INFO 15]</infoadc15>
<infoadc16>[INFO 16]</infoadc16>
<infoadc17>[INFO 17]</infoadc17>
<infoadc18>[INFO 18]</infoadc18>
<infoadc19>[INFO 19]</infoadc19>
<infoadc20>[INFO 20]</infoadc20>
<data_validade>[DATA VALIDADE]</data_validade>
</destinatario>
<destinatario codigo="[CODIGO]">
(...)
</destinatario>
(...)
</emkt>
</main>
Todos os campos do destinatrio exceto e-mail so de uso opcional, portanto a
omisso de <nome></nome> por exemplo, pode ser feita sem problemas.

Retorno:
<main>
<emkt trans="11.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<return id="99">
<EMAIL_INVALIDO>[EMAIL]</EMAIL_INVALIDO>
( )
<FALHA_INSERIR>[EMAIL]</FALHA_INSERIR>
( )
</return>
</emkt>
</main>

O arquivo de retorno poder eventualmente apresentar uma lista de e-mails que

foram considerados invlidos pelo sistema na tag EMAIL_INVALIDO.
Tambm poder ocorrer erro de insero do contato, este tipo de erro ser
retornado na tag FALHA_INSERIR.
Mesmo que ocorrera qualquer um dos erros acima mencionado a API ir fazer a
insero de todos os e-mails vlidos.

20.10) Importao de arquivo para a ao

Envio:
<main>
<emkt trans="20.10">
<acao>[TITULO DA AO]</acao>
<indice>[E/C]</indice>
<envio>0000-00-00 00:00</envio>
<arquivo>[URL DO ARQUIVO]</arquivo>
<separador>[SEPARADOR]</separador>
<opcoes cabecalho="[S/N]" reenviar="[S/N]" />
<campos>
<email col="[NUMERO DA COLUNA]" />
<nome col="[NUMERO DA COLUNA]" />
<sexo col="[NUMERO DA COLUNA]" />

<idade col="[NUMERO DA COLUNA]" />

<data_nascimento col="[NUMERO DA COLUNA]" />
<codigo_externo col="[NUMERO DA COLUNA]" />
<empresa col="[NUMERO DA COLUNA]" />
<cpf col="[NUMERO DA COLUNA]" />
<atividade col="[NUMERO DA COLUNA]" />
<profissao col="[NUMERO DA COLUNA]" />
<tipoend col="[NUMERO DA COLUNA]" />
<endereco col="[NUMERO DA COLUNA]" />
<complemento col="[NUMERO DA COLUNA]" />
<bairro col="[NUMERO DA COLUNA]" />
<cidade col="[NUMERO DA COLUNA]" />
<estado col="[NUMERO DA COLUNA]" />
<pais col="[NUMERO DA COLUNA]" />
<cep col="[NUMERO DA COLUNA]" />
<telefone1 col="[NUMERO DA COLUNA]" />
<telefone2 col="[NUMERO DA COLUNA]" />
<telefone3 col="[NUMERO DA COLUNA]" />
<fax col="[NUMERO DA COLUNA]" />
<infoadc1 col="[NUMERO DA COLUNA]" />
<infoadc2 col="[NUMERO DA COLUNA]" />
<infoadc3 col="[NUMERO DA COLUNA]" />
<infoadc4 col="[NUMERO DA COLUNA]" />
<infoadc5 col="[NUMERO DA COLUNA]" />
<infoadc6 col="[NUMERO DA COLUNA]" />
<infoadc7 col="[NUMERO DA COLUNA]" />
<infoadc8 col="[NUMERO DA COLUNA]" />
<infoadc9 col="[NUMERO DA COLUNA]" />
<infoadc10 col="[NUMERO DA COLUNA]" />
<infoadc11 col="[NUMERO DA COLUNA]" />
<infoadc12 col="[NUMERO DA COLUNA]" />
<infoadc13 col="[NUMERO DA COLUNA]" />
<infoadc14 col="[NUMERO DA COLUNA]" />
<infoadc15 col="[NUMERO DA COLUNA]" />
<infoadc16 col="[NUMERO DA COLUNA]" />
<infoadc17 col="[NUMERO DA COLUNA]" />
<infoadc18 col="[NUMERO DA COLUNA]" />
<infoadc19 col="[NUMERO DA COLUNA]" />
<infoadc20 col="[NUMERO DA COLUNA]" />
</campos>
</emkt>
</main>
ndice: o ndice utilizado para identificar os contatos, o valor padro E (Email).
Envio: a data/hora de envio da ao, caso no seja informada ela agendada
para ser enviada 5 minutos aps a requisio.
Arquivo: Endereo do arquivo a ser importado, aceita os protocolos HTTP, HTTPS,
FTP e FTPS.
O sistema suporta arquivos nos formatos ZIP, XLS, CSV e Texto. O arquivo no
formato ZIP deve conter somente um arquivo dentro no formato XLS, CSV ou Texto.
Exemplo: ftp://user:senha@ftp.dominio.com.br/pasta/arquivo.zip
Separador: O caractere que separa as colunas do arquivo. No formato Excel esse
campo no obrigatrio.
Opes -> Cabealho: Informa se o arquivo a ser importado tem cabealho.
Opes -> Reenvio: Informa se o mesmo contato pode receber mais de uma vez essa
mesma ao.
*Todos os campos exceto e-mail so opcionais, portanto a omisso das demais
colunas pode ser feita sem problemas.

Retorno:
<main>
<emkt trans="20.10" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<processo>[CODIGO MD5]</processo>
</emkt>
</main>

20.11) Situao de processo da transao de importao de arquivo para a ao

(20.10)
Envio:
<main>
<emkt trans="20.11">
<processo>[CODIGO MD5]</processo>
</emkt>
</main>

Retorno:
<main>
<emkt trans="20.11" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
<return id="00">Ok</return>
<progresso>[PERCENTUAL]</progresso>
<resultado>
<erro>[MENSAGEM DE ERRO]</erro>
<acao>[NOME DA LISTA]</acao>
<arquivo>[NOME DO ARQUIVO]</arquivo>
<linhas>[LINHAS NO ARQUIVO]</linhas>
<duplicados>[CONTATOS DUPLICADOS NO ARQUIVO]</duplicados>
<inseridos>[CONTATOS INSERIDOS]</inseridos>
<atualizados>[CONTATOS ATUALIZADOS]</atualizados>
<cadastrados>[CONTATOS J CADASTRADOS]</cadastrados>
<validos_antes>[CONTATOS ANTES DA IMPORTAO]</validos_antes>
<validos_apos>[CONTATOS APS IMPORTAO]</validos_apos>
</resultado>
</emkt>
</main>