akna - integração via webservice.pdf

26
 Página 1 Integração de Funcionalidades do sistema Todas as transações devem seguir o padrão abaixo: Envio de uma requisição POST para o endereço: http://api.akna.com.br/emkt/int/integracao.php Com os seguintes campos: User = E-mail do usuário Pass = Senha do usuário criptografada com MD5 Client = Código da empresa no sistema, se o usuário só faz parte de uma empresa o campo não é obrigatório XML = Conteúdo da Solicitação  Atenção: O sistema faz diferenciação entre letras maiúsculas e minúsculas por tanto mantenha User, Pass e XML exatamente como escrito aqui. Todas as transações retornam um XML, e no caso de erro de pedido i ncorreto, alguns padrões de códigos de retorno são respeitados para todos os tipos de transações, são eles. 01 = Usuário e/ou senha inválidos 02 = Permissão Negada 03 = Transação Inválida 05 - Usuário pertence a mais de uma empresa, obrigatorio envio de código de empresa 06 - Acesso negado  ATENÇÃO: Os campos que estão em preto no XML são obrigatórios e o XML deve se r enviado codificado em UTF-8.

Upload: heliodiniz

Post on 16-Oct-2015

382 views

Category:

Documents


8 download

TRANSCRIPT

  • Pgina 1

    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.

  • Pgina 2

    01) Controle de usurios e equipes

    01.10) Cria um novo usurio

    Envio:

    [E-MAIL]

    [NOME]

    [SENHA]

    [SENHA]

    [NOME_EQUIPE]

    [DOCUMENTO]

    [pt-br/es/en]

    [TELEFONE]

    [TELEFONE]

    [S/N]

    [S/N]

    [S/N]

    [999.999.999.999];(...)

    [AAAA-MM-DD]

    [S/N]

    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:

    Ok

    01.13) Editar um usurio

    Envio:

    [E-MAIL]

    [NOME]

    [SENHA]

    [SENHA]

    [NOME_EQUIPE]

    [DOCUMENTO]

    [pt-br/es/en]

    [TELEFONE]

    [TELEFONE]

    [S/N]

    [S/N]

    [S/N]

  • Pgina 3

    [999.999.999.999];(...)

    [AAAA-MM-DD]

    [S/N]

    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:

    Ok

    01.15) Excluir um usurio

    Envio:

    [E-MAIL]

    Retorno:

    Ok

    01.20) Criar uma nova equipe

    Envio:

    [NOME_EQUIPE]

    [TRUE]

    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:

  • Pgina 4

    Ok

    01.22) Lista todas as equipes cadastradas

    Envio:

    Retorno:

    Equipe 1

    Equipe 1|Equipe 1.1

    Equipe 1|Equipe 1.1|Equipe

    1.1.1

    (...)

    01.23) Edita uma equipe.

    Envio:

    [NOME_EQUIPE]

    [NOVO_NOME_EQUIPE]

    [TRUE]

    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:

    Equipe1|Equipe1.1|Equipe1.1.1

    Equipe2|Equipe2.1

    TRUE

    Depois da operao correr com sucesso a estrutura ficar como a descrita

    abaixo:

    Equipe1|Equipe1.1

  • Pgina 5

    Equipe2|Equipe2.1

    Retorno:

    Ok

    01.25) Apaga uma equipe.

    Envio:

    [NOME_EQUIPE]

    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:

    Ok

  • Pgina 6

    11) Controle de Lista de endereos (contatos)

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

    Envio:

    [TITULO DA LISTA]

    [E-MAIL ou CODIGO EXTERNO]

    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:

    [NOME]

    [SEQUENCIA]

    [EMAIL]

    [SEXO]

    [IDADE]

    [DATA_NASCIMENTO]

    [ENDERECO]

    [COMPLEMENTO]

    [BAIRRO]

    [CIDADE]

    [ESTADO]

    [PAIS]

    [CEP]

    [TELEFONE 1]

    [TELEFONE 2]

    [TELEFONE 3]

    [FAX]

    [INFO 01]

    [INFO 02]

    [INFO 03]

    [INFO 04]

    [INFO 05]

    [INFO 06]

    [INFO 07]

    [INFO 08]

    [INFO 09]

    [INFO 10]

    [INFO 11]

    [INFO 12]

    [INFO 13]

    [INFO 14]

    [INFO 15]

    [INFO 16]

    [INFO 17]

    [INFO 18]

    [INFO 19]

    [INFO 20]

    [DATA VALIDADE]

  • Pgina 7

    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:

    [NOME DA LISTA]

    [S/N]

    [NOME]

    [EMAIL]

    [SEXO]

    [IDADE]

    [DATA_NASCIMENTO]

    [EMPRESA]

    [CPF]

    [ATIVIDADE]

    [PROFISSAO]

    [TIPO DE ENDERECO]

    [ENDERECO]

    [COMPLEMENTO]

    [BAIRRO]

    [CIDADE]

    [ESTADO]

    [PAIS]

    [CEP]

    [TELEFONE 1]

    [TELEFONE 2]

    [TELEFONE 3]

    [FAX]

    [INFO 01]

    [INFO 02]

    [INFO 03]

    [INFO 04]

    [INFO 05]

    [INFO 06]

    [INFO 07]

    [INFO 08]

    [INFO 09]

    [INFO 10]

    [INFO 11]

    [INFO 12]

    [INFO 13]

    [INFO 14]

    [INFO 15]

    [INFO 16]

    [INFO 17]

    [INFO 18]

    [INFO 19]

    [INFO 20]

    [DATA VALIDADE]

    (...)

    (...)

    Substituir: O valor padro N (No), mas caso seja informado S (Sim) todos os e-

    mails da lista sero removidos antes da importao.

    Destinatario.Codigo: O cdigo externo do destinatrio opcional

  • Pgina 8

    Retorno:

    Ok

    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:

    [NOME DA LISTA]

    [E/C]

    [S/N]

    [URL DO ARQUIVO]

    [SEPARADOR]

    [I/S/R]

  • Pgina 9

    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

    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 por exemplo, pode ser feita sem problemas.

    Retorno:

    [CODIGO MD5]

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

    Envio:

    [CODIGO MD5]

    Retorno:

    Ok

    [PERCENTUAL]

    [MENSAGEM DE ERRO]

    [NOME DA LISTA]

    [NOME DO ARQUIVO]

    [LINHAS NO ARQUIVO]

    [CONTATOS DUPLICADOS NO ARQUIVO]

    [CONTATOS INSERIDOS]

    [CONTATOS ATUALIZADOS]

    [CONTATOS INVALIDOS]

    [CONTATOS COM E-MAIL ERRADOS]

    [CONTATOS J CADASTRADOS]

    [CONTATOS VALIDOS ANTES DA IMPORTAO]

    [CONTATOS VALIDOS APS IMPORTAO]

  • Pgina 10

    11.20) Histrico de aes por perodo

    Envio:

    AAAA-MM-DD HH:MM:SS

    AAAA-MM-DD HH:MM:SS

    [E-MAIL DO USURIO]

    [S]

    A diferena entre a data inicial e data final no pode ser maior que 24 horas

    Retorno:

    [CODIGO MD5]

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

    Envio:

    [CODIGO MD5]

    Retorno:

    Ok

    [PERCENTUAL]

    [MENSAGEM DE ERRO]

    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:

    [CODIGO MD5]

  • Pgina 11

    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.90) Insere opt-out / Opt-in

    Envio:

    [ACAO] (0 = Opt-out, 1 = Opt-In)

    [EMAIL] (E-mail que ser setado opt-out ou opt-in)

    [CATEGORIA]

    [CATEGORIA]

    [CATEGORIA]

    (...)

    Retorno:

    Ok

    Retorno com falha:

    Categoria no encontrada (Lista de categorias separadas por

    virgula)

  • Pgina 12

    11.95) Retorna os opt-out do dia

    Envio:

    AAAA-MM-DD

    Retorno:

    [AAAA-MM-DD HH:MM:SS]

    [EMAIL DO CONTATO]

    [NOME DA ACAO]

    [DESCRICAO DO MOTIVO]

    [NOME DA AREA DE INTERESSE]

    (...)

    Esse processo s considera aes no arquivadas

  • Pgina 13

    15) Controle de Mensagens

    15.05) Criao de Mensagem

    Envio:

    [NOME DA MENSAGEM]

    [NOME DA CATEGORIA]

    [CDIGO DO IDIOMA]

    [HTML]

    [TEXTO ALTERNATIVO]

    [MENSAGEM DE VISUALIZAO ALTERNATIVA]

    [MENSAGEM DE OPT-OUT]

    [MENSAGEM DE ENCAMINHAMENTO]

    [MENSAGEM REDES SOCIAIS]

    [REDES SOCIAIS]

    [NOME DO LINK]

    [NOME DO LINK]

    (...)

    A mensagem html deve ter os caracteres "", """ e "&" substitudos por

    "", """ e "&" 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 :

    [NOME DO LINK]

    Redes sociais, enviar os cdigos das redes desejadas separados por vrgula, segue

    abaixo lista de redes disponveis.

    DLC => Delicious

    DIG => Digg

    FCB => Facebook

    FSQ => Fresqui

    GBM => Google Bookmarks

    MNM => Mename

    MYY => My Yahoo

    MYS => Myspace

    ORK => Orkut

    TWT => Twitter

    WLV => Windows Live

  • Pgina 14

    Retorno:

    Ok

    15.50) Lista de mensagens cadastradas

    Envio:

    AAAA-MM-DD

    AAAA-MM-DD

    A data inicial e a data final no so obrigatrios e podem ser informados

    separadamente.

    Retorno:

    [TITULO DA MENSAGEM]

    AAAA-MM-DD

    15.55) Informaes da mensagem

    Envio:

    [TITULO DA MENSAGEM]

    Retorno:

    [TITULO DA MENSAGEM]

    AAAA-MM-DD

    [CONTEUDO DA MENSAGEM]

    [TEXTO ALTERNATIVO]

    [TEXTO DA MENSAGEM DE OPTOUT]

    [TEXTO DA MENSAGEM DE VISUALIZACAO

    ALTERNATIVA]

    [TEXTO DA MENSAGEM DE

    ENCAMINHAMENTO]

    [TEXTO DA MENSAGEM DE ALTERAO DE

    CADASTRO]

    [NOME DO ARQUIVO]

  • Pgina 15

    (...)

    [TITULO DO LINK]

    [URL DO LINK]

    (...)

  • Pgina 16

    19) Controle de Campanhas

    19.05) Incluso de uma nova ao

    Envio:

    [NOME DA ACAO]

    [NOME OU LINK DA MENSAGEM]

    [E-MAIL USUARIO]

    [SIGLA DO IDIOMA]

    [REA DE INTERESSE]

    [ENVIAR SOMENTE QUANDO A MENSAGEM CONTIVER]

    [AAAA-MM-DD]

    [NOME DO REMETENTE]

    [EMAIL DO REMETENTE]

    [EMAIL PARA RETORNO]

    [ASSUNTO]

    [EMAIL DE TERMINO]

    [S/N]

    [NOME DA LISTA]

    [NOME DA LISTA]

    (...)

    [E-MAIL]

    [MM-DD]

    [MM-DD]

    [1/2/3/99]

    [99]

    [99]

    [99]

    [S/N]

    [99]

    [M/F]

    [99999999]

    [99999999]

    [BAIRRO]

    [CIDADE]

    [UF]

    [SP]

    (...)

    [CONTEUDO]

    [CONTEUDO]

    (...)

    [TITULO DA ACAO]

    [TITULO DA ACAO]

    (...)

  • Pgina 17

    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:

    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:

    Tipo_busca > I Seja igual a, O Comece com, T Termine com, C

    contenham, N No contenham, E Seja menor que, A Seja maior que, V Esteja

    entre.

    Evento -> AE Apresentaram erro na ao, VA Visualizaram a ao, CA

    Clicaram na ao

    Retorno:

    Ok

    19.06) Agendamento de envio da ao

    Envio:

    [NOME DA CAMPANHA]

    YYYY-MM-DD HH:MM:SS

    [PRIORIDADE]

    [NO ENVIAR EM MENOS DE X HORAS]

    [NUMERO DE ENVIOS NO DISPARO]

    [REINICIAR O ENVIO APS X HORAS]

    [QUANTIDADE DE DIAS PARA O REENVIO PARCIAL]

    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 = Alta

    N = Normal

    B = Baixa

    P = 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.

  • Pgina 18

    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:

    Ok

    19.10) Estatsticas das aes em um determinado perodo

    Envio:

    AAAA-MM-DD HH:MM:SS

    AAAA-MM-DD HH:MM:SS

    Retorno:

    Ok

    [CODIGO]

    [NOME]

    [REMETENTE]

    [EMAIL]

    [EMAIL2]

    (...)

    (...)

    (...)

    19.11) Totais da campanhas

    Envio:

    [NOME DA CAMPANHA]

    Retorno:

  • Pgina 19

    Ok

    [TOTAL DE DESTINATARIOS]

    [TOTAL ENVIADO]

    [TOTAL ENTREGUE]

    [TOTAL DE ERROS]

    [TOTAL DE VISUALIZAES]

    [TOTAL DE INDICAES]

    [TOTAL DE PEDIDOS DE REMOO]

    [TOTAL DE CLICKS]

    [TITULO DO LINK]

    [TOTAL DE CLICKS UNICOS]

    [TOTAL DE CLICKS]

    (...)

    [TIPO DE ERRO]

    [TOTAL DE ERROS]

    (...)

    19.31) Contatos que visualizaram a campanha

    Envio:

    [NOME DA CAMPANHA]

    Retorno:

    Ok

    [E-MAIL]

    (...)

    19.55) Informaes da ao

    Envio:

    [TITULO DA AO]

    Retorno:

    [TITULO DA AO]

  • Pgina 20

    AAAA-MM-DD

    [NOME DO REMETENTE]

    [E-MAIL DO REMETENTE]

    [E-MAIL DE RETORNO]

    [CAMPANHA DA AO]

    [TITULO DA MENSAGEM UTILIZADA]

    [URL DE ORIGEM DA MENSAGEM]

    [CONTEUDO DA MENSAGEM]

    [TEXTO ALTERNATIVO]

    [TEXTO DA MENSAGEM DE OPTOUT]

    [TEXTO DA MENSAGEM DE VISUALIZACAO

    ALTERNATIVA]

    [TEXTO DA MENSAGEM DE

    ENCAMINHAMENTO]

    [TEXTO DA MENSAGEM DE ALTERAO DE

    CADASTRO]

    [NOME DO ARQUIVO]

    (...)

    [TITULO DO LINK]

    [URL DO LINK]

    (...)

    [AREA DE INTERESSE]

    AAAA-MM-DD HH:MM:SS

    AAAA-MM-DD HH:MM:SS

    [TOTAL DE CONTATOS DA AO]

    [TOTAL DE ENVIOS]

    19.80) Lista de e-mails invlidos da campanha

    Envio:

    [TITULO DA CAMPANHA]

    Retorno:

    Ok

    [CODIGO]

    [NOME]

    [REMETENTE]

    [EMAIL]

    [EMAIL2]

    (...)

  • Pgina 21

  • Pgina 22

    20) Alteraes de listas das aes

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

    Envio:

    [TITULO DA AO]

    [E/C]

    [NOME]

    [EMAIL]

    [SEXO]

    [IDADE]

    [DATA_NASCIMENTO]

    [EMPRESA]

    [CPF]

    [ATIVIDADE]

    [PROFISSAO]

    [TIPO DE ENDERECO]

    [ENDERECO]

    [COMPLEMENTO]

    [BAIRRO]

    [CIDADE]

    [ESTADO]

    [PAIS]

    [CEP]

    [TELEFONE 1]

    [TELEFONE 2]

    [TELEFONE 3]

    [FAX]

    [INFO 01]

    [INFO 02]

    [INFO 03]

    [INFO 04]

    [INFO 05]

    [INFO 06]

    [INFO 07]

    [INFO 08]

    [INFO 09]

    [INFO 10]

    [INFO 11]

    [INFO 12]

    [INFO 13]

    [INFO 14]

    [INFO 15]

    [INFO 16]

    [INFO 17]

    [INFO 18]

    [INFO 19]

    [INFO 20]

    [DATA VALIDADE]

    (...)

    (...)

    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 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.

  • Pgina 23

    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.

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

    ao 19.06

    Retorno:

    Ok

    20.05) Incluso de contatos direto na ao com agendamento de envio (Aes on-demand)

    Envio:

    [TITULO DA AO]

    [E/C]

    [MINUTOS]

    [NOME]

    [EMAIL]

    [SEXO]

    [IDADE]

    [DATA_NASCIMENTO]

    [EMPRESA]

    [CPF]

    [ATIVIDADE]

    [PROFISSAO]

    [TIPO DE ENDERECO]

    [ENDERECO]

    [COMPLEMENTO]

    [BAIRRO]

    [CIDADE]

    [ESTADO]

    [PAIS]

    [CEP]

    [TELEFONE 1]

    [TELEFONE 2]

    [TELEFONE 3]

    [FAX]

    [INFO 01]

    [INFO 02]

    [INFO 03]

    [INFO 04]

    [INFO 05]

    [INFO 06]

    [INFO 07]

    [INFO 08]

    [INFO 09]

    [INFO 10]

    [INFO 11]

    [INFO 12]

    [INFO 13]

    [INFO 14]

    [INFO 15]

    [INFO 16]

    [INFO 17]

    [INFO 18]

    [INFO 19]

  • Pgina 24

    [INFO 20]

    [DATA VALIDADE]

    (...)

    (...)

    Todos os campos do destinatrio exceto e-mail so de uso opcional, portanto a

    omisso de por exemplo, pode ser feita sem problemas.

    Retorno:

    Ok

    20.10) Importao de arquivo para a ao

    Envio:

    [TITULO DA AO]

    [E/C]

    0000-00-00 00:00

    [URL DO ARQUIVO]

    [SEPARADOR]

  • Pgina 25

    ndice: o ndice utilizado para identificar os contatos, o valor padro E (E-

    mail).

    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:

    [CODIGO MD5]

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

    (20.10)

    Envio:

    [CODIGO MD5]

    Retorno:

    Ok

    [PERCENTUAL]

    [MENSAGEM DE ERRO]

    [NOME DA LISTA]

    [NOME DO ARQUIVO]

    [LINHAS NO ARQUIVO]

    [CONTATOS DUPLICADOS NO ARQUIVO]

  • Pgina 26

    [CONTATOS INSERIDOS]

    [CONTATOS ATUALIZADOS]

    [CONTATOS J CADASTRADOS]

    [CONTATOS ANTES DA IMPORTAO]

    [CONTATOS APS IMPORTAO]