Junto com este manual, exemplos codificados em XML e php ajudarão no entendimento da elaboração de rotinas em sua linguagem de programação. A seguir, cases dos principais métodos utilizados para manipulação via webservice.
Cada campo de requisição possui uma especificação de tipo que pode ser: texto/alfanumérico (string), números (integer), vetor (array) e “verdadeiro/falso” (boleanos). Nestes casos, deve-se respeitar a determinação indicada na biblioteca WSDL, pois sua interpretação determinará o tipo de retorno (informações requisitadas) ou mensagens de erro (erros de parse ou com resposta false/0). Tome cuidado com espaços entre os valores. No caso de login e senha, poderá ocorrer erro de autenticação. Toda requisição possui um tipo de resposta, que pode ser tanto positivo (true), como negativo (false) ou um conjunto de informações conforme indicado método e explanado anteriormente. Todos os métodos possuem a mesma introdução, modificando apenas a função conforme a necessidade.
Case 1 – Adicionar e/ou atualizar informações de um único contato
O método “AdicionaAtualizaContato” tem o intuito de adicionar e/ou atualizar informações de um único contato através da integração webservice de forma esporádica, pontual.
Será requisitado para que o contato (email – chave primária que não se repete) pertença a uma ou mais listas de contatos e que também possua suas informações adicionais cadastradas em seus respectivos campos adicionais. A informação de Lista alterará a associação pré-existente. No caso do contato pertencer a mais de uma lista e sua indicação na requisição for de apenas uma, o mesmo será desassociado as listas anteriores e associado ao código informado.
Observação 1: Para inserir informações em campos adicionais, os mesmos já deverão existir na plataforma, caso contrário uma mensagem de erro ou false será retornada. O mesmo para campos de chave primária.
Observação 2: A quantidade de requisição deste método interfere diretamente no processamento do mesmo. Execute até 15 requisições por minuto no máximo. Caso deseje cadastrar mais contatos, utilize outros métodos como “AdicionaAtualizaContatos” ou “importaContatos”.
Observação 3: Tanto este método com em outros que executam a função de cadastramento de contatos, o status dos contatos pré-existentes não se alteram, seja ele um opt-out (blacklist), um erro permanente (hardbounce) ou qualquer outro status que não seja como ativo.
Case 2
– Adicionar e/ou atualizar informações de uma lista de
contatos
O método “AdicionaAtualizaContatos” tem o intuito de adicionar e/ou atualizar informações de uma lista de contatos. Em uma requisição apenas, é possível cadastrar e/ou atualizar até 15 contatos com seus devidos campos adicionais.
Além de ser uma boa prática, agiliza o tempo de execução e minimiza a demanda de processamento que possa prejudicar o desempenho e gerar lentidão no webservice.
Caso a opção “manterlista” não estiver marcada como verdadeiro, a nova informação de lista substituirá os dados pré-existentes ao invés de acrescentá-los.
Se executado com sucesso todos os contatos, um retorno verdadeiro (true) será passado. Caso contrário, uma excessão será informada com a indicação do problema. Normalmente o problema se restringe a sintaxe do e-mail.
Observação: Lembrando que para inserir informações em campos adicionais, os mesmos já deverão existir na plataforma, caso contrário uma mensagem de erro ou false será retornada. O mesmo para campos de chave primária.
Case 3 – Importação de Contatos
O método “ImportaContatos” tem o intuito de adicionar e/ou atualizar informações de uma pilha de registros, através de um arquivo do tipo CSV, onde será compactado no formato ZIP de até 5mb e encodado (criptografado) como base 64. Este método completa as funções dos cases anteriores em apenas uma requisição. Indicado para carregamento de grande quantidade de contatos.
A indicação dos campos serve para associar os campos adicionais da plataforma com as colunas existentes no arquivo CSV. Processo este feito pela indicação do nome do campo adicional em maiúscula e o posicionamento por números da coluna do arquivo CSV iniciado por 1.
Observação 1: Arquivo ZIP não poderá ultrapassar a capacidade de 5mb. Observação 2: Arquivo ZIP deverá ser criptografado apenas como base 64.
Observação 3: A associação de campos adicionais e colunas deverá ocorrer de forma precisa, pois o erro de posicionamento gerará uma lista sem contatos cadastrados/atualizados.
Observação 4: No processo de importação, o retorno via webservice é verdadeiro (true), porém neste mesmo instante uma rotina interna a plataforma foi iniciada para captação das informações. Para checar o processo de importação, utilize o método “RetornaDadosLista” onde o campo status indica o status real da importação da lista indicada. Se for necessário, utilize em sua rotina esta validação para que em sua conclusão possa executar outros métodos como “CriaNovoEnvio” para efetuar um disparo utilizando esta lista como base de contatos.
Case 4 – Retornar dados e status de um único contato
Para obter informações de um contato em específico, recomenda-se usar o método “RetornaDadosContato”. Este método tem como retorno todas as informações pertinentes ao contato e seus campos adicionais, como também seu status e em que lista se encontra através de sua identificação pelo campo principal de “e-mail”.
Observação: Evite efetuar múltiplas requisições via webservice pois, além de ser uma boa prática, agiliza o tempo de execução e minimiza a demanda de processamento que possa prejudicar o desempenho e gerar lentidão no webservice.
Case 5 – Criar novo envio
Para efetuar um envio dinamicamente, um com junto de informações deverão constar na programação quando chamado o método “CriarNovoEnvio”.
Observação 1: Quando executado este método, uma validação sobre os filtros de segmentação ocorrerá. Caso não se encontre contatos ativos, o envios ficará com o status de “em edição” e o retorno será que foi retornado 0 (zero) contatos para este envio.
Observação 2: O envio não será executado caso não haja créditos em sua conta, pois sua execução é imediata (disparo no mesmo momento e/ou programada).
Case 6 – Convite de Reativação de contato de BlackList
Método que solicita ao contato bloqueado a oportunidade de sua reativação por meio de sua intervenção manual, optando pela confirmação ou não do mesmo.
Observação: Quando executado, um e-mail será encaminhado ao e-mail do contato. Os dados de nome e email de remetente deverão ser verídicos para a execução pela plataforma e o recebimento correto pelo provedor do cliente, na qual valida o tráfego dos e-mails pelas boas práticas de e-mail marketing (certificações/autenticações – SPF dentre outros).
Rua Bandeira Paulista, 275 - 12º andar
04532-010 São Paulo SP Brasil
Fale com a gente
+55 11 3708-4000 contato@virtualtarget.com.br
Descubra tudo sobre a Experian Virtual Target
virtualtarget.com.br
Acompanhe-nos no Facebook
facebook.com/ExperianVirtualTarget
Siga-nos no Twitter
twitter.com/virtualtarget