Base de Conhecimento

Integração API

A integração através de nosso XML API permite o acesso remotamente entre bancos e informações externas.
O XML API torna possível integrar dados externos para atualizar seu sistema sem a necessidade de acessá-lo fisicamente.

Como XML é uma linguagem de marcação de propósito geral que puder usá-lo para a comunicação entre os aplicativos baseados em Java para PHP.

Por exemplo, você pode configurar o seu sistema para atualizar automaticamente listas de contatos, criar e enviar e-mail, campanhas, coletar estatísticas e muitas outras funções.

Requisitos

Solicitar a liberação de seu usertoken para o suporte, seu usertoken será semelhante a este:

Exemplo:  d467e49b221137215ebdab1ea4e046746de7d0ea

Submeter um Pedido

Uma solicitação POST XML com os detalhes para o a ser gerado deverá ser enviado para o 'Caminho XML'
que você pode encontrar nas "Contas de Usuário -> Editar Usuário sob o 'User Aba 'Permissões.

Certifique-se de que você tem o API ativado ou solicite para  'Ativar a API XML'.  caso seja o administrador de seu sistema (revenda) você será capaz de ativar o token XML API do usuário.

O Caminho XML semelhante a este:  http://www.dominio.com.br/xml.php    ( Ou seja o domínio de seu painel /xml.php )

O 'nome de utilizador' e 'userToken' mencionado nos exemplos a seguir podem ser encontrados nesta mesma secção sob o título de 'XML Username' e, respectivamente, 'XML token.

Esta seção irá descrever as diferentes funções que podem ser utilizados pelo XML API.

A estrutura do documento XML para 'Adicionando um assinante e detalhes personalizados associados »pedido é tão
segue :

• xmlrequest (Obrigatório)
• username - O nome de usuário usado para fazer login no sistema. (Obrigatório)
• usertoken - O token exclusivo atribuído à conta de usuário utilizada acima. (Obrigatório)
• requesttype - O nome do arquivo de API em questão. (Obrigatório)
• requestmethod - O nome da função que está sendo chamado. (Obrigatório)
• details (Obrigatório)
• emailaddress - O endereço de e-mail do contato que está sendo adicionado. (Obrigatório)
• mailinglistid - A lista que o contato está localizado dentro. (Obrigatório)
• confirmed - Define o status de confirmação de que o assinante confirmada ou não (sim ou y ou verdadeiro ou 1) (Não é necessário, por defeito de não confirmado)
• format - O formato das campanhas de e-mail que esse contato prefere receber  (html ou h ou texto ou t) (padrão para texto)
• customfields
• item
• fieldid - O id do campo personalizado que está sendo adicionado.
• value - O valor a ser adicionado a este campo personalizado.

Resposta bem sucedida

Após a apresentação de um retorno válido 'add assinante à lista submissão um contato será adicionado à lista de contatos e o número de identificação de contatos retornado.

O formato é o seguinte:
• response
• status - O valor do campo de status será "sucesso" para uma resposta bem sucedida.
• data - O número de identificação de contatos.Sample Request (XML)

O seguinte exemplo de código executa uma inserção de 'email@dominio.com.br' o usuário para a lista de discussão com ID '1 ', status definido como "confirmado", o formato definido para' html 'e com um campo personalizado de nome definido como' João Alfredo '.

01.
02. admin
03. d467e49b221137215ebdab1ea4e046746de7d0ea
04. subscribers
05. Add na Lista
06.

07. email@dominio.com.br
08. 1
09. html
10. yes
11.
12.
13. 1
14. João Alfredo
15.
16.
17.
18. Exemplo Request (PHP)

 

O seguinte exemplo de código é escrito em PHP e faz uso da funcionalidade CURL do PHP para inserir o acima XML para o aplicativo.

01. 02. $xml = '
03. admin
04. d467e49b221137215ebdab1ea4e046746de7d0ea
05. subscribers
06. Add na Lista
07.

08. email@dominio.com.br
09. 1
10. html
11. yes
12.
13.
14. 1
15. João Alfredo
16.
17.
18.
19.
20. ';
21.
22. $ch = curl_init('http://www.dominiodeseupainel.com.br/xml.php');
23. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
24. curl_setopt($ch, CURLOPT_POST, 1);
25. curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
26. $result = @curl_exec($ch);
27. if($result === false) {
28. echo "Error performing request";
29. }
30. else {
31. $xml_doc = simplexml_load_string($result);
32. echo 'Status is ', $xml_doc->status, '
';
33. if ($xml_doc->status == 'SUCCESS') {
34. echo 'Data is ', $xml_doc->data, '
';
35. } else {
36. echo 'Error is ', $xml_doc->errormessage, '
';
37. }
38. }
39.
40. ?>

 

Resposta quebrada

Este exemplo demonstra uma mensagem de erro que é retornado quando uma solicitação não é feita corretamente.
Note-se que a etiqueta de detalhes no exemplo não está fechado e não ListId é enviado para a função de usar.
A estrutura de um documento XML para este exemplo é como se segue:

• xmlrequest (Obrigatório)
• username - O nome de usuário usado para fazer login no Interspire Email Marketer. (Obrigatório)
• usertoken - O token exclusivo atribuído à conta de usuário utilizada acima. (Obrigatório)
• requesttype - O nome do arquivo de API em questão. (Obrigatório)
• requestmethod - O nome da função que está sendo chamado. (Obrigatório)
• details (Obrigatório)

Resposta malsucedida

Após o envio de uma resposta errônea devido a um campo faltando, ou um valor inválido o pedido falhará.
Uma mensagem de status será devolvido via XML como isso.
Neste exemplo, você será presenteado com a mensagem de erro:

'O XML fornecido não é válido. Por favor, verifique o documento xml e tente novamente. '

O formato é o seguinte:

• response
• status - O valor do campo de estado será "ERRO".
• errormessage - Uma MENSAGEM de Texto explicando Por Que a solicitação falhou.

Exemplo Request (XML)
O seguinte Exemplo de Código IRA tentar postar hum Pedido de para a função de obter listas.

01.
02. admin
03. 78701d1ba2588ea1991f44299b814129658c6947
04. lists
05. GetLists
06.
07. Sample Request (PHP)

O seguinte exemplo de código é escrito em PHP e faz uso da funcionalidade CURL do PHP para inserir o
acima XML para o aplicativo.

01. 02. $xml = '
03. admin
04. 78701d1ba2588ea1991f44299b814129658c6947
05. lists
06. GetLists
07.
08. ';
09.
10. $ch = curl_init('http://www.yourdomain.com/IEM/xml.php');
11. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
12. curl_setopt($ch, CURLOPT_POST, 1);
13. curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
14. $result = @curl_exec($ch);
15. if($result === false) {
16. echo "Error performing request";
17. }
18. else {
19. $xml_doc = simplexml_load_string($result);
20. echo 'status is ', $xml_doc->status, '
';
21. if ($xml_doc->status == 'SUCCESS') {
22. print_r($result);
23. } else {
24. echo 'Error is ', $xml_doc->errormessage, '
';
25. }
26. }?>

Verificando token

Este exemplo irá verificar para ter certeza de que o sinal de que você está usando é um token válido.
Observe que a tag detalhes no exemplo ainda está incluído, embora não haja detalhes necessários.

• xmlrequest (Obrigatório)
• username - O nome de usuário usado para fazer login no sistema. (Obrigatório)
• usertoken - O token exclusivo atribuído à conta de usuário utilizada acima. (Obrigatório)
• requesttype - O nome do arquivo de API em questão. (Obrigatório)
• requestmethod - O nome da função que está sendo chamado. (Obrigatório)
• details (Obrigatório)

Retorno com Sucesso

O formato é o seguinte:

• response
• status - O valor do campo de status será "sucesso" para uma resposta bem sucedida.
• data - Isso irá retornar '1 'para uma autorização de sucesso.

Retorno mal Sucedido

Após o envio de uma resposta errônea devido a um campo faltando, ou um valor inválido, a verificação de token
falhará. Uma mensagem de status será devolvido via XML como isso.
Neste exemplo, você será presenteado com a mensagem de erro:
'Detalhes inválido'

O formato é o seguinte:

• response
• status - O valor do campo de status será "ERRO".
• errormessage - Uma mensagem de texto explicando por que a solicitação falhou.

Exemplo Request (XML)

O seguinte exemplo de código executa uma verificação de autorização no userToken para certificar-se de que é um
token válido.

01.
02. admin
03. 78701d1ba2588ea1991f44299b814129658c6947
04. authentication
05. xmlapitest
06.

07.
08.

 

Exemplo Request (PHP)

O seguinte exemplo de código é escrito em PHP e faz uso da funcionalidade CURL do PHP para inserir o
acima XML para o aplicativo.

01. 02. $xml = '
03. admin
04. 78701d1ba2588ea1991f44299b814129658c6947
05. authentication
06. xmlapitest
07.

08.
09. ';
10.
11. $ch = curl_init('http://www.dominiodaaplicacao.com.br/xml.php');
12. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
13. curl_setopt($ch, CURLOPT_POST, 1);
14. curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
15. $result = @curl_exec($ch);
16. if($result === false) {
17. echo "Error performing request";
18. }
19. else {
20. $xml_doc = simplexml_load_string($result);
21. echo 'status is ', $xml_doc->status, '
';
22. if ($xml_doc->status == 'SUCCESS') {
23. print_r($result);
24. } else {
25. echo 'Error is ', $xml_doc->errormessage, '
';
26. }
27. }
28. ?>

 

Apagando usuário:

Este exemplo vai apagar um contato da sua lista de contatos.

• xmlrequest (Obrigatório)
• username - O nome de usuário usado para fazer login no sistema. (Obrigatório)
• usertoken - O token exclusivo atribuído à conta de usuário utilizada acima. (Obrigatório)
• requesttype - O nome do arquivo de API em questão. (Obrigatório)
• requestmethod - O nome da função que está sendo chamado. (Obrigatório)
• detalhes (Obrigatório)
• list - O ID da lista de contatos que você está desejando procurar (Obrigatório)
• emailaddress - O endereço de e-mail do contato que você está tentando localizar (Obrigatório)

Retorno com Sucesso

Após o envio do pedido de um "assinante delete 'válida a API XML irá retornar um status de sucesso.

O formato é o seguinte:

• response
• status - O valor do campo de status será "sucesso" para uma resposta bem sucedida.
• data
• item- a contagem de assinantes removidos corretamente.

Retorno mal Sucedido

Após o envio de uma resposta errônea devido a um campo faltando, ou um valor inválido para apagar.

Se o pedido falhar para receber o reqiest de uma mensagem de status será devolvido via XML como isso.

O formato é o seguinte:

• response
• status - O valor do campo de status será "ERRO".
• errormessage - Uma mensagem de texto explicando por que a solicitação falhou.Sample Request (XML)

O seguinte exemplo de código irá apagar o endereço de e-mail listado na lista de contatos deste ID.

Exemplo Request (XML)

01.
02. admin
03. 78701d1ba2588ea1991f44299b814129658c6947
04. subscribers
05. DeleteSubscriber
06.

07. email@domain.com
08. 1
09.
10. Sample Request (PHP)

 

O seguinte exemplo de código é escrito em PHP e faz uso da funcionalidade CURL do PHP para inserir o
acima XML para o aplicativo.

Exemplo Request (PHP)

01. 02. $xml = '
03. admin
04. 78701d1ba2588ea1991f44299b814129658c6947
05. subscribers
06. DeleteSubscriber
07.

08. email@dominio.com.br
09. 1
10.
11. ';
12.
13. $ch = curl_init('http://www.dominio.com.br/xml.php');
14. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
15. curl_setopt($ch, CURLOPT_POST, 1);
16. curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
17. $result = @curl_exec($ch);
18. if($result === false) {
19. echo "Error performing request";
20. }
21. else {
22. $xml_doc = simplexml_load_string($result);
23. echo 'status is ', $xml_doc->status, '
';
24. if ($xml_doc->status == 'SUCCESS') {
25. print_r($result);
26. } else {
27. echo 'Error is ', $xml_doc->errormessage, '
';
28. }
29. }
30. ?>

 

Obter dados com campos personalizados

A estrutura do documento XML para recuperar um contato lista de dados de campo personalizado é a seguinte:

• xmlrequest (Obrigatório)
• username - O nome de usuário usado para fazer login no sistema. (Obrigatório)
• usertoken - O token exclusivo atribuído à conta de usuário utilizada acima. (Obrigatório)
• requesttype - O nome do arquivo de API em questão. (Obrigatório)
• equestmethod - O nome da função que está sendo chamado. (Obrigatório)
• details (Obrigatório)
• listids- O ID da lista de contatos do que os dados de campo personalizado está sendo solicitado. (Obrigatório)

Retorno com Sucesso

Após o envio de uma "Obter dados do campo personalizado" submissão válida os dados de campo personalizado encontrado será retornado em formato XML.

O formato é o seguinte:

• response
• status - O valor do campo de status será "sucesso" para uma resposta bem sucedida.
• data
• item
• fieldid - O costume campos número de identificação.
• name - O nome do campo personalizado.
• fieldtype - o tipo de campo (texto, número, etc.)
• defaultvalue - Se você definir um valor padrão será exibido aqui.
• required - Se este campo é obrigatório a ser preenchido (1 ou 0).
• fieldsettings - versão serializada das configurações de campos personalizados

Retorno mal Sucedido

Após o envio de uma resposta errônea devido a um campo faltando, ou um valor inválido o Get Personalizado

Se os dados arquivados falhar. Uma mensagem de status será devolvido via XML como isso.

O formato é o seguinte:

• response
• status - O valor do campo de status será "ERRO".
• errormessage - Uma mensagem de texto explicando por que a solicitação falhou.

Exemplo Request (XML)

O seguinte exemplo de código irá tirar qualquer informação encontrada nos campos personalizados para a lista com o ID de ‘1’.

01.
02. admin
03. 78701d1ba2588ea1991f44299b814129658c6947
04. lists
05. GetCustomFields
06.

07.
08. 1
09.
10.
11.
 

 

Exemplo Request (PHP)

O seguinte exemplo de código é escrito em PHP e faz uso da funcionalidade CURL do PHP para inserir o acima XML para o aplicativo.

01. 02. $xml = '
03. admin
04. 78701d1ba2588ea1991f44299b814129658c6947
05. lists
06. GetCustomFields
07.

08.
09. 1
10.
11.
12.
13. ';
14.
15. $ch = curl_init('http://www.yourdomain.com/IEM/xml.php');
16. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
17. curl_setopt($ch, CURLOPT_POST, 1);
18. curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
19. $result = @curl_exec($ch);
20. if($result === false) {
21. echo "Error performing request";
22. }
23. else {
24. $xml_doc = simplexml_load_string($result);
25. echo 'status is ', $xml_doc->status, '
';
26. if ($xml_doc->status == 'SUCCESS') {
27. print_r($result);
28. } else {
29. echo 'Error is ', $xml_doc->errormessage, '
';
30. }
31. }
32. ?>
 

 

Obter listas

Este exemplo irá recuperar uma lista de todas as listas de contatos que estão localizados em seu painel e retornar XML formatado com os dados encontrados.

Observe que a tag detalhes no exemplo ainda está incluído, embora não haja detalhes necessários.

• xmlrequest (Obrigatório)
• username - O nome de usuário usado para fazer login no sistema. (Obrigatório)
• usertoken - O token exclusivo atribuído à conta de usuário utilizada acima. (Obrigatório)
• requesttype - O nome do arquivo de API em questão. (Obrigatório)
• requestmethod - O nome da função que está sendo chamado. (Obrigatório)
• details (Obrigatório)

Retorno com Sucesso

Após a apresentação de um pedido válido 'get listas de a API XML retornará todos os dados encontrados no sistema será devolvido em formato XML.

O formato é o seguinte:

• response
• status - O valor do campo de status será "sucesso" para uma resposta bem sucedida.
• data
• item
• listid - O ID da lista.
• name - O nome da lista.
• subscribecount - A contagem de quantos contatos registrados.
• unsubscribecount - A contagem de quantos contatos sobras.
• autorespondercount - A contagem de quantas autoresponders são ligada à Lista de Contatos.

Retorno mal Sucedido

Após o envio de uma resposta errônea devido a um campo faltando, ou um valor inválido as Listas.

se falhar. Uma mensagem de status será devolvido via XML como isso.

Neste exemplo, você será presenteado com a mensagem de erro:

'Detalhes inválido'

O formato é o seguinte:

• response
• status - O valor do campo de status será "ERRO".
• errormessage - Uma mensagem de texto explicando por que a solicitação falhou.

Exemplo Request (XML)

Após o envio de uma resposta errônea devido a um campo faltando, ou um valor inválido o seguinte código executa um pedido para retornar o erro.

01.
02. admin
03. 78701d1ba2588ea1991f44299b814129658c6947
04. user
05. GetLists
06.

07.
08.
 

 

Exemplo Request (PHP)

O seguinte exemplo de código é escrito em PHP e faz uso da funcionalidade CURL do PHP para inserir o XML para o aplicativo.

01. 02. $xml = '
03. admin
04. 78701d1ba2588ea1991f44299b814129658c6947
05. user
06. GetLists
07.

08.
09. ';
10.
11. $ch = curl_init('http://www.yourdomain.com/IEM/xml.php');
12. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
13. curl_setopt($ch, CURLOPT_POST, 1);
14. curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
15. $result = @curl_exec($ch);
16. if($result === false) {
17. echo "Error performing request";
18. }
19. else {
20. $xml_doc = simplexml_load_string($result);
21. echo 'status is ', $xml_doc->status, '
';
22. if ($xml_doc->status == 'SUCCESS') {
23. print_r($result);
24. } else {
25. echo 'Error is ', $xml_doc->errormessage, '
';
26. }
27. }
28. ?>

 

Get Inscritos

Este exemplo irá recuperar uma contagem da quantidade de contatos na lista em questão, bem como uma lista de todos os contatos que estão localizados nessa lista e retornar formatado XML com os dados encontrados.

• xmlrequest (Obrigatório)
• username - O nome de usuário usado para fazer login no sistema. (Obrigatório)
• usertoken - O token exclusivo atribuído à conta de usuário utilizada acima. (Obrigatório)
• requesttype - O nome do arquivo de API em questão. (Obrigatório)
• requestmethod - O nome da função que está sendo chamado. (Obrigatório)
• details (Obrigatório)
• searchinfo
• List - O ID da lista de contatos que você está desejando procurar
(Obrigatório)
• Email - O endereço de e-mail do contato que você está tentando
localizar (Obrigatório)

Retorno com Sucesso

Após a apresentação de um pedido válido 'get assinantes' a API XML retornará uma contagem da quantidade de Contatos na lista em questão, juntamente com uma lista dos endereços de e-mail de contato no formato XML.

O formato é o seguinte:

• response
• status - O valor do campo de status será "sucesso" para uma resposta bem sucedida.
• data
• count - A contagem da quantidade de assinantes.
• subscriberlist - Uma lista de assinantes endereços de e-mail.

Retorno mal Sucedido

Após o envio de uma resposta errônea devido a um campo faltando, ou um valor inválido, o request dos Inscritos falhar. Uma mensagem de status será devolvido via XML como isso.

O formato é o seguinte:

• response
• status - O valor do campo de status será "ERRO".
• errormessage - Uma mensagem de texto explicando por que a solicitação falhou.

Exemplo Request (XML)

O seguinte exemplo de código executa uma verificação na lista de contatos com ID '1 'para todos os endereços de e-mail que
conter a informação "@dominio.com.br '.

01.
02. admin
03. 78701d1ba2588ea1991f44299b814129658c6947
04. subscribers
05. GetSubscribers
06.

07.
08. 1
09. @yourdomain.com
10.
11.
12.

 

Exemplo Request (PHP)

O seguinte exemplo de código é escrito em PHP e faz uso da funcionalidade CURL do PHP para inserir o acima XML para o aplicativo.

01. 02. $xml = '
03. admin
04. 78701d1ba2588ea1991f44299b814129658c6947
05. subscribers
06. GetSubscribers
07.

08.
09. 1
10. @yourdomain.com
11.
12.
13. ';
14.
15. $ch = curl_init('http://www.seudominio.com.br/xml.php');
16. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
17. curl_setopt($ch, CURLOPT_POST, 1);
18. curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
19. $result = @curl_exec($ch);
20. if($result === false) {
21. echo "Error performing request";
22. }
23. else {
24. $xml_doc = simplexml_load_string($result);
25. echo 'status is ', $xml_doc->status, '
';
26. if ($xml_doc->status == 'SUCCESS') {
27. print_r($result);
28. } else {
29. echo 'Error is ', $xml_doc->errormessage, '
';
30. }
31. }
32. ?>

 

 

É o contato na lista

Este exemplo irá verificar se um determinado contato está localizado em uma lista de contatos particular.

• xmlrequest (Obrigatório)
• username - O nome de usuário usado para fazer login no sistema. (Obrigatório)
• usertoken - O token exclusivo atribuído à conta de usuário utilizada acima. (Obrigatório)
• requesttype - O nome do arquivo de API em questão. (Obrigatório)
• requestmethod - O nome da função que está sendo chamado. (Obrigatório)
• details (Obrigatório)
• Email - O endereço de e-mail do contato que você está procurando (Obrigatório)
• List - O ID da lista de contatos que você está querendo procurar (Obrigatório)

Retorno com Sucesso

Após a apresentação de um válido "é o contato na lista de 'pedido a API XML retornará true se localiza o contato e retornará nada se não encontrar.

O formato é o seguinte:

• response
• status - O valor do campo de status será "sucesso" para uma resposta bem sucedida.
• data - voltará '1 'se o contato está localizado.

Retorno mal Sucedido

Após o envio de uma resposta errônea devido a um campo faltando, ou um valor inválido, a um contato em se Lista falhar. Uma mensagem de status será devolvido via XML como isso.

O formato é o seguinte:

• response
• status - O valor do campo de status será "ERRO".
• errormessage - Uma mensagem de texto explicando por que a solicitação falhou.

Exemplo Request (XML)

O seguinte exemplo de código executa uma verificação em uma lista de contatos para ver se um determinado contato está listado nele.

01.
02. admin
03. 78701d1ba2588ea1991f44299b814129658c6947
04. subscribers
05. IsSubscriberOnList
06.

07. email@dominio.com.br
08. 1
09.
10.
 

 

Exemplo Request (PHP)

O seguinte exemplo de código é escrito em PHP e faz uso da funcionalidade CURL do PHP para inserir o acima XML para o aplicativo.

01. 02. $xml = ' subscribers
03. IsSubscriberOnList
04.

05. email@yourdomain.com
06. 1
07.
08. ';
09.
10. $ch = curl_init('http://www.dominiodaaplicacao.com.br/xml.php');
11. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
12. curl_setopt($ch, CURLOPT_POST, 1);
13. curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
14. $result = @curl_exec($ch);
15. if($result === false) {
16. echo "Error performing request";
17. }
18. else {
19. $xml_doc = simplexml_load_string($result);
20. echo 'status is ', $xml_doc->status, '
';
21. if ($xml_doc->status == 'SUCCESS') {
22. print_r($result);
23. } else {
24. echo 'Error is ', $xml_doc->errormessage, '
';
25. }
26. }
27. ?>

 

A integração do API com dados externos deve ser desenvolvido pelo programador do contratante conforme suas necessidades e programação usando os exemplos práticos descrito nesta documentação.

########################  EXEMPLOS ########################

Exemplo para criar campanha por API: 

if (!defined('IEM_NO_CONTROLLER')) {
    define('IEM_NO_CONTROLLER', true);
}
require_once dirname(__FILE__) . '/admin/index.php';
require_once (SENDSTUDIO_FUNCTION_DIRECTORY . '/sendstudio_functions.php');
$sendstudio_functions = new Sendstudio_Functions();
$newsapi = $sendstudio_functions->GetApi('Newsletters');
$newsapi->htmlbody = "This is a test newsletter!
With HTML!";
$newsapi->textbody = "Your email client cannot read this email.\n
              To view it online, please go here: %%webversion%%\n\n
               To stop receiving these emails:%%unsubscribelink%%";
$newsapi->name = "Test Campaign";
$newsapi->format = "b"; //h for html only, t for text only, b for both
$newsapi->active = 1; // Is the campaign active? 1 for yes, 0 for no
$newsapi->archive = 1; // Archive the campaign? 1 for yes, 0 for no
$newsapi->subject = "Test campaign creation";
$newsapi->ownerid = 1; // 1 is usually admin
if(! $newsapi->Create()){
    echo "Creation failed!";
} else {
    echo "Newsletter ID: " . $newsapi->newsletterid;
}
?>

Você pode adicionar um e-mail ou uma lista de e-mails para a lista de supressão global ou específico da lista usando a API XML ou a API do PHP (usar o script PHP que figura como referência):  

if (!defined('IEM_NO_CONTROLLER')) {
    define('IEM_NO_CONTROLLER', true);
}

require_once 'admin/index.php'; //Change to location of your /emailmarketer/admin/index.php file
require_once(SENDSTUDIO_FUNCTION_DIRECTORY . '/sendstudio_functions.php');

$emailaddress = ''; // email of the contact that you want unsubscribed
$listid = ''; // id of the contat list this subscriber should be unsubscribed from
$subscriberid = ''; // id of the subscriber

$SendstudioFunctions = new Sendstudio_Functions();
$subscriber_api = $SendstudioFunctions->GetApi('Subscribers');
$result = $subscriber_api->UnsubscribeSubscriber($emailaddress,$listid,$subscriberid);

if ($result[0])
{
    echo "$emailaddress was successfully unsubscribed.";
}
else
{
    echo "Error: ".$result[1];
}
?>

você pode escrever um script como este para adicionar um usuário a uma lista de contatos: 

$installDir = 'your IEM install directory';
$emailAddress = 'your email address to add to the contact list';
$contactListId = 'your contact list ID';
 
defined('IEM_NO_CONTROLLER') or define('IEM_NO_CONTROLLER',true); //bypass login prompt

 require($installDir.'/admin/index.php');  //pull in base required classes
 require($installDir.'/admin/functions/api/subscribers.php'); //pull in Subscribers API
 
 $subscriber_api = &new Subscribers_API();
 $subscriber_api->AddToList($emailAddress, $contactListId); 
?>

Cada classe e método contém uma descrição detalhada. Você pode baixar phpDocumentor gratuitamente no phpdoc.org.
A seguir é um exemplo de um pedido API XML enviado através PHP com cURL

. 

//searchinfo
// must contain a list id: 1 or any
// You can also filter the search by Status, Confirmed, CustomFields, Subscriber, Email, Format, Newsletter, Link, etc
// I took the list above from the function GenerateSubscriberSubQuery line 2199 of /api/subscribers.php
$xml = "

    YOUR_USERNAME_HERE
    YOUR_TOKEN_HERE
    subscribers
    GetSubscribers
    
        
            1
            a
            1
        
    

";

$ch = curl_init('http://YOUREMAILMARKETER.com/xml.php'); //change to the path to your xml.php file
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
$result = @curl_exec($ch);
if($result != false) {
    $xml_doc = simplexml_load_string($result);
    if($xml_doc != false){
        echo "Result: 
";
        var_dump($xml_doc);
        echo "

";
    }        
} else {
        echo "Error performing request: 
";
        var_dump($result);
        echo "

";
    }    

?>

Neste arquivo você encontra alguns exemplos de como criar usuário, criar campanhas, ver estatísticas, criar lista de bloqueio, remoção, inserção de lista utilizando PHP, lembrando que os exemplos são apenas para guiar os parâmetros de uso e possibilidades para interagir com sistemas web, mobile ou desktop conforme sua necessidade:  Download Aqui ! 

 

Veja também