Email Marketing, Newsletter / Funcionalidades / Integracion / HTTP API

HTTP API

Disfruta las extraordinarias ventajas de utilizar nuestra API de integración. ¡Ahorra tiempo y esfuerzo!

Comienza hoy

Introdução

1.Introdução

O que é?

El API HTTP es una herramienta que te permite integrar EnvialoSimple.com con tus aplicaciones mediante simples llamadas a URLs.

La interfaz (API) te ofrece innumerables funcionalidades agrupadas por módulos para facilitar su utilización e implementación.

A través de la nueva API HTTP de EnvialoSimple.com podrás enviar tu campañas de email marketing; crear, modificar y eliminar contactos, listas de contactos y campañas; consultar estadísticas y reportes integrando todas las funcionalidades de EnvialoSimple.com en tu propia aplicación.

Todas as URLs têm a mesma estrutura:

https://app.envialosimple.com/<modulo>/<accion>?APIKey=<api key>&format=<format>

<modulo>Simboliza um grupo de ações. É possível tomar os valores:

  • campaign
  • member
  • report
  • maillist

<accion> - Ação particular a realizar. Esta ação depende do módulo. Toma valores como "list", "add", "edit", etc.

<api key> - Token de autenticação. Estes token são gerados desde sua conta de EnvieSimples.com nas "Configurações Avançadas".

<format> - Formato de saída do pedido. Os formatos suportados são:

  • json
  • xml

Resposta (Estrutura)

Todas las respuestas empiezan con un nodo "root" seguido por "ajaxResponse" si es que el formato de salida es "json" o directamente los datos después del nodo "root" si el formato de salida es XML.

Si NO se producen errores durante la ejecución de la operación se retorna un nodo "success" junto a los datos correspondientes al método. De lo contrario encontraremos un nodo "errors" con códigos de error.

Exemplo:

Sucesso:

{
            "root": {
                "ajaxResponse": {
                    "success": true,
                    <resposta particular do serviço>
                }
            }
        }

Erro:

{
            "root":{
                "ajaxResponse":{
                    "errors":{
                        <tokens de erro>:<detalhe de erro se corresponder>
                    }
                }
            }
        }

Exemplo prático de uma resposta com mensagem de erro:

Chamada: https://app.envialosimple.com/member/list/format/json?count=1asdResposta:
{
        "root":{
            "ajaxResponse":{
                "errors":{
                "errorMsg_formValidations":{
                    "count":[
                    "notDigits"
                        ],
                    "absolutepage": [ ],
                    "filter": [ ],
                    "orderBy": [ ],
                    "desc": [ ],
                    "MailListsIDs": [ ]
                    }
                }
            }
        }
    }

Módulo campaign

1.Listar Campanhas

Serviço:

/campaign/list

Liste todas as campanhas filtradas por nome

Parâmetros:

Parâmetrocount
RequeridoNÃO
TipoNúmero Inteiro >0
ExplicaçãoNúmero de campanhas a devolver como máximo
Exemplocount=10
Parâmetroabsolutepage
RequeridoNÃO
TipoNúmero Inteiro >0
ExplicaçãoPágina de "count" à que se deseja ir. Se count vale 10 e absolutepage vale 3, então começaremos a ver desde a campanha 31
Exemploabsolutepage=3
Parâmetrostatus
RequeridoNÃO
TipoArreglo de Cadena de Caracteres
Valores Posibles:

Active(Pendiente de aprobación, pendiente, preparando o enviando)
Inactive(Borrador, pausada o detenida)

Completed(Enviada)
ExplicaçãoTipos de estado pelos que se deseja filtrar a lista
Exemplostatus[] = Inactive&status[] = Completed
Parâmetrofilter
RequeridoNÃO
TipoCadeia de Caracteres
ExplicaçãoNome ou parte do nome pelo que se filtram as campanhas
Exemplofilter=Promoção de Verão
ParâmetroorderBy
RequeridoNÃO
TipoCadeia de Caracteres
ExplicaçãoValores posibles:
name (Nombre de la campaña)
id (Id de la campaña)
ExemploorderBy=name
Parâmetrodesc
RequeridoNÃO
TipoNúmero Entero
Valores posibles:
1 (si)
0 (no)
ExplicaçãoDetermina se a ordem do listado é ascendente ou descendente
Exemplodesc=1

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada é incorreto, falta ou é solicitado. Tem associada uma entrada do tipo "Parámetro inválido"=>"error"
errorMsg_noCampaigns
Por um erro inesperado não foi possível realizar nenhuma consulta

Estrutura de Saída:

campaign.CampaignID
ID da campanha
campaign.Name
Nome da campanha
campaign.Status
Estado de envío
  • [Draft(Rascunho)
  • Halted|Paused(Em pausa)
  • Stopped(Detido)
  • Completed(Concluído)
  • Pending(Pendentes)
  • Sending(Enviando)
  • Completed(Enviada)]
Só as campanhas em Paused ou Stopped podem-se enviar
campaign.ScheduleType
Tipo de programação de envio [Not scheduled | Send Now | One time scheduled]
campaign.schedule.ScheduleSendDate
Data programada para o envío. Só válido se o tipo é "One time scheduled"
campaign.schedule.ScheduleErrorStatus
Erros verificados durante o envío (ver quadro abaixo)

** Só documentam-se os campos mais relevantes.

ScheduleErrorStatus:

errorMsg_remoteContentNotFound
No se ha podido recuperar el contenido remoto de tu campaña
errorMsg_campaignNotFound
La campaña ha sido eliminada y no puede recuperarse
errorMsg_administratorSuspended
La cuenta se encontraba suspendida al momendo de intentar enviar la campaña
errorMsg_administratorExhaustedQuota
Tu cuenta no tenía créditos disponibles y la operación fué detenida
errorMsg_maillistsEmpty
La lista de destinatarios utilizada no posee contactos activos

** Só se documentam os erros mais relevantes.

2.Recuperar informação de uma Campanha

Serviço:

/campaign/load

Recupere informação de uma Campanha

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro >0
ExplicaçãoIdentificador da campanha a recuperar
ExemploCampaignID=10

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, falta ou é solicitado. Tem associada uma estrutura do tipo "Parâmetro inválido"=>"erro".
errorMsg_campaignInvalidID
Por um erro inesperado não foi possível realizar nenhuma consulta
errorMsg_campaignNotFound
Não é possível encontrar a campanha
errorMsg_campaignMaillistNotFound
Não é possível encontrar as listas associadas
errorMsg_campaignContentNotFound
Não é possível encontrar o conteúdo da campanha
errorMsg_campaignScheduleNotFound
Não é possível encontrar a programação da campanha

Estrutura de Saída

campaign.CampaignID
ID da campanha
campaign.Name
ID da campanha
campaign.Status
Estado de envio. (Apenas em pausa ou campanhas parado pode ser enviada)Valores possíveis
  • [Draft(Rascunho)
  • Paused(Em pausa)
  • Stopped(Detido)
  • Pending(Pendentes)
  • Pendingfor Approval(Pendendo aprovação)
  • Sending (Enviando)
  • Completed (Concluído)
Só as campanhas em Paused ou Stopped podem-se enviar
campaign.schedule.ScheduleType
Tipo de programação de envio. Valores possíveis:
  • Not scheduled(Sem Programação)
  • Send Now(Enviar)
  • One time scheduled(Previsão de Entrega.)
campaign.schedule.ScheduleSendDate
Data programada para o envío. Só válido se o tipo é "One time scheduled"
campaign.schedule.ScheduleErrorStatus
Erros verificados durante o envío (ver quadro abaixo)

3.Criar ou Alterar a informação de uma campanha

Serviço:

/campaign/save

Crie ou altere a informação de uma campanha. A chamada deve ser feita através de POST

Parâmetros:

ParâmetroCampaignID
RequeridoNÃO
TipoNúmero Inteiro >0
ExplicaçãoIdentificador da campanha que se deseja alterar
ExemploCampaignID=2
ParâmetroCampaignName
RequeridoSIM
TipoCadeia de caracteres
ExplicaçãoIdentificador da campanha que se deseja alterar
ExemploCampaignName=Campaña de navidad
ParâmetroCampaignSubject
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoAssunto com que será enviada a campanha
ExemploCampaignSubject=Feliz Navidad
ParâmetroMailListsIds
RequeridoNÃO
TipoArray de inteiros >0
ExplicaçãoIDs de listas às que será enviada a campanha
ExemploMailListsIds[]=4
ParâmetroFromID
RequeridoNÃO
TipoNúmero Inteiro >0
ExplicaçãoID de e-mail de administrador designado como origem da campanha (FROM)
ExemploFromID=3
ParâmetroReplyToID
RequeridoNÃO
TipoNúmero Inteiro >0
ExplicaçãoID do e-mail de administrador designado como e-mail de resposta (ReplyTO)
ExemploReplyToID=4
ParâmetroTrackLinkClicks
RequeridoNÃO
Tipo0 o 1 (por default 0)
ExplicaçãoSe o parâmetro for = 1, serão registrados todos os cliques que se fizerem nos links uma vez enviada a campanha
ExemploTrackLinkClicks=1
ParâmetroTrackReads
RequeridoNÃO
Tipo0 o 1 (por default 0)
ExplicaçãoSe o parâmetro for = 1, será registrado toda vez que um contato abrir um e-mail de campanha
ExemploTrackReads=1
ParâmetroTrackAnalitics
RequeridoNÃO
Tipo0 o 1 (por default 0)
ExplicaçãoSe o parâmetro for = 1, serão agregados a cada link os parâmetros solicitados por "google analitics" para fazer um seguimento da campanha
ExemploTrackAnalitics=0
ParâmetroSendStateReport
RequeridoNÃO
Tipo0 o 1 (por default 0)
ExplicaçãoSe o parâmetro for = 1, ao terminar de enviar a campanha, será enviado um e-mail ao dono da conta informando a situação
ExemploSendStateReport=0
ParâmetroScheduleCampaign
RequeridoNÃO
Tipo0 o 1 (por default 0)
ExplicaçãoSe o parâmetro for = 1, se é necessário registrar a "Programação de envío" da campanha
ExemploScheduleCampaign=1
ParâmetroSendDate
RequeridoNÃO
TipoData com o formato yyyy-MM-dd HH:mm:ss
ExplicaçãoData de envío da campanha. Este parâmtro depende de "ScheduleCampaign"
ExemploSendDate=2012-11-20 14:10:00
ParâmetroAddToPublicArchive
RequeridoNÃO
Tipo0 o 1 (por default 0)
ExplicaçãoAdicionar a campanha ao "arquivo público de campanhas"
ExemploAddToPublicArchive=1

** Só documentam-se os campos mais relevantes.

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada é incorreto, falta ou é solicitado
errorMsg_invalidCampaignDate
A data de envio é menor à data atual
errorMsg_campaignIsCompletedNotSaved
A campanha que se solicita alterar já foi enviada
errorMsg_campaignMaillistsNotSaved
Não foi possível salvar as contatos
errorMsg_phishing
A campanha é detectada como possível tentativa de golpe
errorMsg_campaignContentNotSaved
Não foi possível salvar o assunto ou parâmetros relacionados com o conteúdo da campanha
errorMsg_campaignScheduleNotSaved
Não foi possível salvar pogramação de envios.
errorMsg_campaignLoad
Não é possível recuperar a campanha
errorMsg_campaignNotPost
Os parâmetros foram passados por GET e devem ser passados por POST
errorMsg_campaignNotFound
Una vez guardados los datos, se intenta verificar la correcta persistencia de los datos. Si no se puede encontrar la campaña se retorna este error
errorMsg_campaignMaillistNotFound
Una vez guardados los datos, se intenta verificar la correcta persistencia de los datos. Si no se pueden encontrar las listas asociadas se retorna este error
errorMsg_campaignContentNotFound
Una vez guardados los datos, se intenta verificar la correcta persistencia de los datos. Si no se puede encontrar el contenido de la campaña se retorna este error
errorMsg_campaignScheduleNotFound
Una vez guardados los datos, se intenta verificar la correcta persistencia de los datos. Si no se puede encontrar la programación de la campaña se retorna este error

Estrutura de Saída:

** Devolve todos os paràmetros de entrada e agrega s seguintes dados:.

campaign.integrity.status
= 1 Se a campanha tem toda a informação necessária para ser enviada
= -1
campaign.integrity.schedule
= 1 se a informação de programação de envio é correta e completa
= -1
campaign.integrity.status
= 1 Se a campanha tem toda a informação necessária para ser enviada
= -1
campaign.integrity.subject
= 1 se tem assunto
= -1
campaign.integrity.content
= 1 se o corpo dos e-mails não está vazio
= -1
campaign.integrity.replyTo
= 1 se tem um e-mail de resposta designado
= -1
campaign.integrity.fromTo
= 1 se tem um e-mail de remetente designado
= -1
campaign.integrity.maillist
= 1 se tem uma ou várias listas designadas
= -1

4.Vista prévia de uma campanha por e-mail ou Navegador

Serviço:

/campaign/preview

Vista prévia de uma campanha por e-mail ou Navegador. Este serviço suporta um tipo de formato de saída ("format") especial. O tipo "email"

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro
ExplicaçãoIdentificador da campanha a recuperar
ExemploCampaignID=10
ParâmetroEmail
RequeridoSó se o formato for "email"
TipoEndereço de correio eletrônico
ExplicaçãoDestinatário de pré-visualização da campanha
ExemploEmail=j.f.fray@envialosimple.com

** Só documentam-se os campos mais relevantes.

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, falta ou é solicitado. Tem associada uma estrutura do tipo "Parâmetro inválido"=>"erro".
errorMsg_campaignNotFound
Não é possível encontrar a campanha
errorMsg_remoteContentEmpty
O conteúdo remoto associado à campanha está vazio
errorMsg_remoteContentNotFound
Não foi possível encontrar o conteúdo remoto associado à campanha
errorMsg_campaignNotPersonalized
Não foi possível substituir os tokens dos campos personalizados.

Estrutura de Saída:

email.fromName
Etiquete nome do e-mail do remetente.
email.from
E-mail do remetente.
email.replyToName
Etiquete nome do e-mail Responder a:
email.replyTo
E-mail de Responder a:
campaign.CampaignName
Nome da campanha
campaign.CampaignName
Nome da campanha
campaign.subject
Assunto da campaña
campaign.HTML
Código HTML da campanha
campaign.plainText
Texto plano alternativo para os clientes que não suportam HTML
campaign.CampaignID
Identificador da campanha

5.Apagar uma campanha

Serviço:

/campaign/delete

Elimine definitivamente uma campanha

Parâmetros:

ParâmetroCampaignIds
RequeridoSIM
TipoArray de números inteiros
ExplicaçãoIds de campanhas a eliminar
ExemploCampaignIds[]=10&CampaignIds[]=1

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada é incorreto, falta ou é solicitado. Tem associada uma estrutura do tipo "Parâmetro inválido"=>"error"
errors.notDeleted
Caso não possa excluir uma campanha, na resposta teremos um nodo "errors" os IDs das campanhas não excluídas e outro nodo"countNotDeleted" com a quantidade de campanhas não excluídas.
Ej: errors:{notDeleted:["10","2"]},countNotDeleted: "2

Caso não possa excluir uma campanha, na resposta teremos um nodo "errors" os IDs das campanhas não excluídas e outro nodo"countNotDeleted" com a quantidade de campanhas não excluídas..

Ej: errors:{notDeleted:["10","2"]},countNotDeleted: "2"

Estrutura de Saída

countDeleted
Número de campanhas excluídas

6.Criar corpo da campanha (HTML/Texto plano)

Serviço:

/content/edit

Crie/Altere o corpo do e-mail da campanha

Ver detalhes do serviço

7.Enviar uma campanha

Serviço:

/campaign/resume

Uma vez criada a campanha com seu conteúdo pode-se iniciar o processo de envío de e-mails aos destinatários. Este método também pode utilizar-se para recomeçar uma campanha pausada.

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro
ExplicaçãoIdentificador da campanha a enviar
ExemploCampaignID=10

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada é incorreto, falta ou é solicitado. Tem associada uma estrutura do tipo "Parâmetro inválido"=>"error"
errorMsg_campaignNotActive
A campanha encontra-se em estado "Draft" pelo que não está pronta para ser enviada.
errorMsg_campaignNotResumed
Não foi possível recomeçar/enviar a campanha
errorMsg_campaignNotScheduled
Não foi possível alterar o estado à configuração do envío
errorMsg_campaignCompleted
A campanha já foi enviada em sua totalidade. Não é possível encaminhar novamente.
errorMsg_maxSimultaneousCampaignLimitExceeded
Não é possível enviar mais de 10 campanhas simultaneamente

Estrutura de Saída

campaign.CampaignID
ID da campanha

8.Pausar campanha

Serviço:

/campaign/pause

Detenha o envio da campanha. Esta campanha poderá ser retomada mais tarde com uma chamada ao serviço "/campaign/resume"

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro
ExplicaçãoIdentificador de la campaña a pausar
ExemploCampaignID=10

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada é incorreto, falta ou é solicitado. Tem associada uma entrada do tipo "Parámetro inválido"=>"error"
errorMsg_campaignNotActive
A campanha encontra-se em estado "Draft" pelo que não está pronta para ser pausada
errorMsg_campaignAlreadyPaused
A campanha já está pausada
errorMsg_campaignStoppedOrCompleted
A campanha está detida ou completa
errorMsg_campaignCompleted
A campanha já foi enviada em sua totalidade. Não é possível pausar
errorMsg_campaignNotPaused
Não foi possível pausar a campanha

Estrutura de Saída

campaign.CampaignID
ID da campanha

9.Exemplos úteis de implementação em PHP

Neste exemplo vamos:

  • 1. criar uma campanha com as características a seguir:
    • 1. Nome: "Promoção de verão"
    • 2. Assunto: "Súper Oferta de Verão!!!"
    • 3. ID de lista de contatos:1
    • 4. ID de e-mail de remetente: 21
    • 5. ID de e-mail de resposta: 21
    • 6. Continuar enlace: sim
    • 7. Contar aberturas: sim
    • 8. Usar Google Analytics: sim
    • 9. Enviar relatório ao finalizar: não
    • 10. Adicionar ao arquivo público:sim
  • 2. Alteração de estado de nvio ativada: sim
  • 3. Programar para envío imediato: sim
  • 4. Criar o conteúdo do e-mail e designá-lo à campanha.
  • 5. Enviar a campanha.

Script

textarefa com o código de script member.php

Saída Script PHP

Nova Campanha: XX

Corpo da campanha criado

Campanha enviada. Para ver o enlace e o resultado da campanha ver o módulo "relatórios"


<?php$baseURL = 'https://app.envialosimple.com';$apiKey = 'TU LLAVE';// Creo nueva campaña$params = array();$params['APIKey']=$apiKey;$params['CampaignName']='Promo Verano';$params['CampaignSubject']='Super Ofertas de verano!!!';$params['MailListsIds']=array('1','2');$params['FromID']='21';$params['ReplyToID']='21';$params['TrackLinkClicks']='1';$params['TrackReads']='1';$params['TrackAnalitics']='1';$params['SendStateReport']='';$params['AddToPublicArchive']='1';$params['ScheduleCampaign']='1';$params['SendNow']='1';$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/campaign/save/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$ok = isset($response['root']['ajaxResponse']['success']);if(!$ok){echo "Error al crear la campaña\n";print_r($response);exit;}$id = $response['root']['ajaxResponse']['campaign']['CampaignID'];$name = $response['root']['ajaxResponse']['campaign']['Name'];echo "Nueva Campaña: $id $name\n";if($response['root']['ajaxResponse']['campaign']['integrity']['status']=='1'){if($response['root']['ajaxResponse']['campaign']['integrity']['subject']=='-1'){echo "Debes asignar un Asunto.\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['schedule']=='-1'){echo "Debes determinar una configuracion de envio\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['content']=='-1'){echo "Debes determinar un contenido de la campaña\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['replyTo']=='-1'){echo "Debes determinar un remitente 'reply to'\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['fromTo']=='-1'){echo "Debes determinar un origen 'from'\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['maillist']=='-1'){echo "Debes determinar una o varias listas de contactos\n";}}// Crea contenido$params = array();$params['APIKey']=$apiKey;$params['CampaignID']=$id;$params['HTML']='<h1>Super ofertas de verano!!!</h1><p>Mirá nuestros <a href="http://mitiendita.com.ar">productos</a></p> <br/> para desuscribirse click <a href="%UnSubscribe%">aquí</a>';$params['PlainText']="Super ofertas de verano!!!\n\n\tMira nustros productos en http://mitiendita.com.ar";// Asigno contenido a la campaña.$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/content/edit/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$ok = isset($response['root']['ajaxResponse']['success']);if(!$ok){echo "No se pudo asigar el contenido del email a la campaña\n";print_r($response);exit;}echo "Cuerpo de campaña creado\n";// Envio la campaña$params = array();$params['APIKey']=$apiKey;$params['CampaignID']=$id;$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/campaign/resume/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$ok = isset($response['root']['ajaxResponse']['success']);if(!$ok){echo "Error al enviar la campaña\n";print_r($response);exit;}if($ok){echo "Campaña enviada. Para ver el avance y el resultado de la campaña ver el modulo de 'reportes'\n";}?>

Módulo content

1.Criar corpo da campanha (HTML/Texto plano)

Serviço:

/content/edit

Recupere, crie ou edite o corpo de e-mail de uma campanha. Se o chamado ao serviço é por GET, recupere a informação do cadastro indicado pelo parâmetro CampaignID. Caso seja por POST Crie ou atualize os dados do cadastro indicado pelo parâmetro CampaignID

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro >0
ExplicaçãoIdentificador da campanha a recuperar
ExemploCampaignID=10
ParâmetroURL
RequeridoNÃO
TipoURL
ExplicaçãoEndereço desde o qual poderá obter o conteudo da campanha. A URL deve estar encodeada como parâmetro. (PHP: rawurlencode). Se este parâmetro estiver presente, o conteudo da campanha será remoto e serão ignorados os parâmetros HTML e Plain Text
ExemploURL=http://misitio.com/modelo.html
ParâmetroHTML
RequeridoNÃO
TipoCadeia de Caracteres
ExplicaçãoCorpo do e-mail em HTML
ExemploPlainText=mi contenido
ParâmetroPlainText
RequeridoNÃO
TipoCadeia de Caracteres
ExplicaçãoCorpo do e-mail em texto plano. Utilizado pelos clientes que não suportarem HTML
ExemploPlainText=mi contenido
ParâmetroRemoteUnsubscribeBlock
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoSe o parâmetro URL está presente (campanha com conteúdo remoto) e quer personalizar o enlace para descadastrar-se, deve-se completar este parâmetro com a etiqueta %UnSubscribe% que será substituido pelo enlace de descadastro
ExemploRemoteUnsubscribeBlock=Para descadastrar-se de nossa lista faça Clique Aqui

Nota:

No conteudo do e-mail deve estar presente um link de descadastro à lista de contatos.

Pode ser fornecido de duas maneiras:

a) Se o conteúdo tiver sido proporcionado através do parâmetro URL (conteúdo remoto) deve indicar-se no parâmetro RemoteUnsubscribeBlock no link de descadastro.

b) Se o conteúdo tiver sido proporcionado através do parâmetro HTML, este deve conter o link de descadastro juntamente com o conteúdo do e-mail. Link de descadastro: ‹span›Para descadastrar-se de nossa lista faça‹/span› ‹a href="%UnSubscribe%" target="_blank"›Clique Aqui‹/a›

O link de descadastro é obrigatório, caso não esteja presente, a API devolverá o erro errorMsg_unSubscribeTagMissing

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada é incorreto, falta ou é solicitado. Tem associada uma entrada do tipo "Parámetro inválido"=>"error"
errorMsg_unSubscribeTagMissing
No corpo do conteúdo do e-mail não foi encontrado o link de descadastro.
errorMsg_contentNotSaved
Não é possível salvar o conteúdo da campanha
errorMsg_campaignNotFound
Não é possível encontrar a campanha

Estrutura de Saída

content.CampaignID
ID da campanha
content.URL
URL do conteúdo remoto
content.PlainText
Texto do corpo do e-mail da campanha para clientes de correio que não suportam HTML
content.HTML
Corpo HTML do e-mail da campanha
content.IsEmpty
1 se o corpo da campanha estiver vazio. (Sem URL, HTML nem PlainText)

** Só documentam-se os campos mais relevantes.

2.Listar plantilhas

Serviço:

/template/gallery

Recupera el listado de plantilla

Parâmetros:

ParâmetroretrieveList
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoDesign de e-mails de suas campanhas
ExemploretrieveList=defaulTemplates
Parâmetrooffset
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoQuantidade de cadastros a partir dos quais começar a recuperar o listado.
Exemplooffset=10
Parâmetrolimit
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoQuantidade de cadastros a recuperar o listado
Exemplolimit=10
ParâmetrofilterListByCategory
RequeridoNÃO
TipoArray de inteiros
ExplicaçãoGrupo de filtros de pesquisa por categoria geral
ExemplofilterListByCategory[]=2
ParâmetrofilterListByCategory2
RequeridoNÃO
TipoArray de inteiros
ExplicaçãoGrupo de filtros de pesquisa por cores
ExemplofilterListByCategory2[]=8

Obs:Cada um dos filtros por categoria produz uma pesquisa de tipo (OR); a combinação dos dois filtros produz uma pesquisa do tipo (OR) AND (OR).Ej. SELECT ... WHERE ( 'filterListByCategory'=5 OR 'filterListByCategory'=7 ) AND ('filterListByCategory2'=16)

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos

Estrutura de Saída

myTemplatesList.template[0].templateId
ID de cadastro (plantilha)
myTemplatesList.template[0].templateTitle
Título da plantilha (se o listado corresponder aos conteúdos de campanhas, é o título da campanha)
myTemplatesList.template[0].templateThumbnail
Informação sobre o print em miniatura do design da plantilha. A rota (path) é relativa ao domínio https://app.envialosimple.com . Caso o listado corresponda às plantilhas predeterminadas deve adicionar em entre o domínio e o path indicado, o prefixo mailing_templates do diretório de plantilhas. Ej. https://app.envialosimple.com/mailing_templates/119/content-t.jpg
myTemplatesList.template[0].templateThumbnailZoom
Rota relativa ao print grande, se existir, do design da plantilha. (as indicações relativas à rota são iguais às da miniatura)

** Só documentam-se os campos mais relevantes.

3.Listar categorias de plantilhas

Serviço:

/campaign/templatecategories

recupere o listado de categorias que se utilizam para recuperar as plantilhas

list.category[]Listado de categorias gerais.

list.color[]Listado de categorias por cor.

Estrutura de Saída:

list.category[]
Listado de categorias gerais
list.color[]
Listado de categorias por cor
list.category[0].CategoryID
ID da categoria
list.category[0].NameToken
Nome da categoria
list.category[0].HasIcon
Os nodos de tipo list.color possuem aqui uma cadeia de caracteres para utilizar como seletores CSS para identificar a cor

Módulo member

1.Listar contatos

Serviço:

/member/list

Exclua um ou mais cintatos de uma ou várias listas de contatos filtrando-os por e-mail

Parâmetros:

ParâmetroMailListsIds
RequeridoNÃO
TipoArray
ExplicaçãoObter só membros das listas selecionadas
ExemploMailListsIds[]=125
Parâmetrocount
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoNúmero de contatos para devolver como máximo
Exemplocount=10
Parâmetroabsolutepage
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoPágina de "count" cadastros à que se deseja ir. Se count vale 10 e absolutepage vale 3, então começaremos a ver desde o contato 31
Exemploabsolutepage=3
Parâmetrofilter
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoE-mail ou parte do e-mail pelo que se filtram os contatos
Exemplofilter=nombre@dominio.com
ParâmetroorderBy
RequeridoNÃO
TipoNúmero entero Cadena de caracteres
Valores posibles:
name
id
ExplicaçãoCampo pelo qual estará ordenado o listado
ExemploorderBy=name
Parâmetrodesc
RequeridoNÃO
TipoNúmero entero
Valores posibles:
0
1
ExplicaçãoCampo pelo qual estará ordenado o listado
Exemplodesc=1

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada é incorreto, falta ou é solicitado. Tem associada uma entrada do tipo "Parámetro inválido"=>"error"
errorMsg_membersNotFound
Não foi possível recuperar os contatos.

Estrutura de Saída:

list.item.MemberID
ID do contato
list.item.Email
E-mail do contato
list.item.BounceType
Tipo de bounce [1=Bounce Duro|2=Bounce Blando|3=Sem Bounces]
list.item.MailLists.activeCount
Número de listas nas que está relacionado o membro
list.item.MailLists.item.MailListID
ID de lista de contatos
list.item.MailLists.item.SubscriptionStatus
Estado de cadastro do membro da lista
list.item.MailLists.item.MailListName
Nome da lista
list.item.CustomFields.item.CustomField<1..100>
Campos personalizados do membro
list.pager.absolutepage
Página que se está mostrando
list.pager.pagecount
Número total de páginas
list.pager.totalCount
Número total de cadastros
list.pager.rowCount
Número de cadastros como máximo por página
customfields
Listado de campos personalizados criados pelo administrador
customfields.rows.CustomFieldID
IDs de campos personalizados
customfields.rows.Title
Títulos de campos personalizados
criteria.filter
Filtro inserido como parâmetro

** só os campos relevantes são explicados e numerados

2.Criar ou Alterar a informação de um Contato

Serviço:

/member/edit

Recupere, Crie ou Altere a informação de um contato.

Este serviço se comporta de formas diferentes dependendo da forma em que realizamos a chamada. Caso façamos através de GET e passamos o parâmetro MemberID, tentará recuperar a informação so contato. Caso utilizemos POST, tentará alterar ou criar o contato dependendo de se estiver ou não definido o parâmetro MemberID

Parâmetros:

ParâmetroMemberID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID do contato que se deseja alterar. Só necessário se deseja recuperar a informação ou alterar o contato.
ExemploMemberID=2
ParâmetroMailListID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoLista na qual será cadastrado inicialmente o contato. Só uma lista deve ser designada.
ExemploMailListID=4
ParâmetroEmail
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoEndereço de correio que deseja cadastrar
ExemploEmail=rogelio@donweb.com
ParâmetroCustomField<1..100>
RequeridoNÃO
TipoArreglo de cadena
ExplicaçãoValores para cada campo personalizado. A parte numérica do parâmetro é o ID do campo personalizado "CustomFieldID"
ExemploCustomField1=rogelio&CustomField3=hombre&CustomField5=argentina

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são solicitados
errorMsg_memberNotFound
Não foi possível encontrar o membro a alterar. Só pode aparecer durante a alteração.
errorMsg_memberNotSaved
Não foi possível salvar o contato por um erro inesperado
errorMsg_memberBanned
Não foi possível cadastrar o contato na lista porque o e-mail está proibido

Estrutura de Saída:

member.MemberID
ID do contato
member.Email
E-mail do contato
member.CustomFields
member.CustomFields.item.CustomField<1..100>

Campos personalizados do membro

** Só os campos relevantes são explicados e numerados.

3.Alterar estado de um Contato (Cadastrar, Descadastrar, Des-associar, etc.)

Serviço:

/member/changestaus

Altere o estado de um ou mais contatos em relação a uma lista ou mais listas

Parâmetros:

ParâmetroMemberIds
RequeridoSIM
TipoArray de inteiros
ExplicaçãoTodos os IDs de contatos aos que se deseja alterar o estado.
ExemploMemberIds[]=1&MemberIds[]=2
ParâmetroMailListsIds
RequeridoSIM
TipoArray de inteiros
ExplicaçãoTodas as listas de contatos com as que deseja operar.
ExemploMailListsIds[]=4&MailListsIds[]=9
ParâmetroSubscriptionStatus
RequeridoSIM
TipoCadeia de caracteres
ExplicaçãoIndica el estado que se quiere asignar a los contactos.
Valores posibles:PendingOptIn (pendiente de confirmación)
Subscribed (suscripto)
Unsubscribed (desuscripto)
Deleted (remover de la lista)
ExemploSubscriptionStatus=Subscribed

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos
invalidMaillist
Lista de IDs de lista de contatos inválidas. Inexistentes
invalidMember
Lista de IDs de contatos inválidos. Inexistentes
subscribed
Lista de IDs de contactos cadastrados corretamente. Este parâmetro só está presente se tiver havido um erro e está presente "notSubscribed"
notSubscribed
Lista de IDs de contatos validos NÃO cadastrados
countNotSubscribed
Quantidade de contatos não cadastrados (notSubscribed invalidMember)

Estrutura de Saída:

countChanged=number
quantidade de membros que foram alterados satisfatoriamente
changestatus
changestatus.detail
changestatus.detail.changed
array que contem uma key por cada MemberID cujo valor é um array de cada MaillistID para a qual foi alterado o estado

Exemplo:

changestatus: {
            detail: {
            changed: {
                2:["4","9"],
                1:["4","9"]
                     }
                    }
                SubscriptionStatus: "Subscribed"
                  }
            countChanged: 2

4.Descadastrar Contatos por e-mail

Serviço:

/member/unsubscribebyemail

Exclua um ou mais cintatos de uma ou várias listas de contatos filtrando-os por e-mail

Parâmetros:

Parâmetroemails
RequeridoSIM
TipoArray de cadeias
ExplicaçãoTodos os e-mails de contatos a descadastrar
Exemploemails[]=toto@tritolo.com&emails[]=juena@gmail.com
ParâmetroMailListsIds
RequeridoSIM
TipoArray de inteiros
ExplicaçãoTodas as listas de contatos à que se desejam descadastrar os MembersIds
ExemploMailListsIds[]=4&MailListsIds[]=9
Parâmetroban
RequeridoNÃO
TipoInteiro[0|1]
ExplicaçãoCrie uma regra de exclusão por cada e-mail do parâmetro e-mails
Exemploban=1

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos

Estrutura de Saída:

countUnsubscribed
Número de membros cadastrados corretamente
notUnsubscribed
Array de e-mails de contatos válidos NÃO descadastrados
countNotUnsubscribed
Quantidade de contatos não descadastrados (notUnsubscribed invalidMember)

5.Exemplos úteis de implementação em PHP:

Neste exemplo vamos:

Criar um contato com e-mail=juanperez@gmail.com, nome=Juan, sobrenome=Perez e cadastrado à lista com ID = 1.

Cadastramos o contato à lista com ID = 2.

Descadastramos da lista 1 ao contato criado no passo 1

Pesquisamos o contato criado no passo 1 dentro da lista 2

Script

textarefa com o código do script member.php

Saída Script PHP

Nuevo Contacto: 19962 - juanperez@gmail.com: Juan Perez

Usuário cadastrado corretamente à lista 2

Usuário descadastrado corretamente da lista 1

El usuario 19962 - juanperez@gmail.com (Juan Perez) esta suscripto a la lista 2


<?php$baseURL = 'https://app.envialosimple.com';$apiKey = 'KEY';//Eu criar um novo contacto na lista 1$params = array();$params['APIKey']=$apiKey;$params['MailListID']=1;$params['Email']='juanperez@gmail.com';$params['CustomField1']='Juan';$params['CustomField2']='Perez';$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/member/edit/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$id = $response['root']['ajaxResponse']['member']['MemberID'];$email = $response['root']['ajaxResponse']['member']['Email'];$nombre = $response['root']['ajaxResponse']['member']['CustomFields']['item']['CustomField1']['Values']['Option'][0]['Value'];$apellido = $response['root']['ajaxResponse']['member']['CustomFields']['item']['CustomField2']['Values']['Option'][0]['Value'];echo "Nuevo Contacto: $id - $email: $nombre $apellido \n";//Cadastramos o contato à lista com ID = 2$params = array();$params['APIKey']=$apiKey;$params['MailListsIds']=array(2);$params['MemberIds']=array($id);$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/member/changestatus/SubscriptionStatus/Subscribed/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$exito = $response['root']['ajaxResponse']['success'];$count = $response['root']['ajaxResponse']['countSubscribed'];if($exito && $count=1){echo "Contacto suscripto correctamente a la lista 2\n";}else{echo "No se pudo suscribir correctamente a la lista 2\n";print_r($response);exit;}//Descadastrado o contato à lista 1$params = array();$params['APIKey']=$apiKey;$params['MailListsIds']=array(1);$params['MemberIds']=array($id);$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/member/changestatus/SubscriptionStatus/Unsubscribed/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$exito = $response['root']['ajaxResponse']['success'];$count = $response['root']['ajaxResponse']['countUnsubscribed'];if($exito && $count=1){echo "Usuário descadastrado corretamente da lista 1\n";}else{echo "No se pudo desuscribir correctamente de la lista 1\n";print_r($response);exit;}//Pesquisamos o contato criado no passo 1 dentro da lista 2$params = array();$params['APIKey']=$apiKey;$params['MailListID']=2;$params['filter']='juanperez';$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/member/listbymaillist/format/json?'.http_build_query($params));curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);foreach ($response['root']['ajaxResponse']['list']['item'] as $item){$tmpid = $item['MemberID'];$tmpemail = $item['Email'];$tmpnombre = $item['CustomFields']['item']['CustomField1']['Values']['Option'][0]['Value'];$tmpapellido = $item['CustomFields']['item']['CustomField2']['Values']['Option'][0]['Value'];echo "El Contacto $tmpid - $tmpemail ($tmpnombre $tmpapellido) esta suscripto a la lista 2\n";}?>

Módulo mailist

Este módulo agrupa serviços de administração de listas de contatos..

1.Listar listas de contatos

Serviço:

/maillist/list

Listar listas de contatos

Parâmetros:

Parâmetrocount
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoNúmero de cadastros como máximo por página
Exemplocount=10
Parâmetroabsolutepage
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoPágina de "count" de cadastros a que é solicitado ir. Se count vale 10 e absolutepage vale 3, então começaremos a ver desde o cadastro 31.
Exemploabsolutepage=3
Parâmetrofilter
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoNome ou parte do nome pelo que se filtram os cadastros
Exemplofilter=Promoção de Verão
ParâmetroorderBy
RequeridoNÃO
Tipocadeia de caracteres possíveis:
  • name (nome da lista)
  • activememberscount (quantidade de membros ativos)
  • memberscount (quantidade de membros totais)
ExplicaçãoCampo pelo qual estará ordenado o listado
ExemploorderBy=name
Parâmetrodesc
RequeridoNÃO
Tipo[1|0]
ExplicaçãoDetermine se a ordem do listado é ascendente (0) ou descendente (1)
Exemplodesc=1

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos
errorMsg_noMaillist
Não foi possível recuperar as listas de contatos

Estrutura de Saída:

list.item.MailListID
ID de lista de contato
list.item.Name
Nome da lista de contatos
list.item.MemberCount
Total de contatos (cadastros e descadastros)
list.item.ActiveMembersCount
Total de contatos cadastrados ou pendentes de descadastro
SubscriptionType
[Opt-in (precisa de confirmação de cadastro) | Free (cadastro sem confirmação)]

2.Criar ou editar informações em uma lista de contatos

Serviço:

/maillist/edit

Recupere, crie ou edite os atributos de uma lista de contatos. Se o chamado ao serviço for por GET, recupere a informação da lista solicitada. Se for por POST crie ou atualize (caso se ingresse o parâmetro MailListID) o nome da lista de contatos

Parâmetros:

ParâmetroMailListID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID da lista de contatos
ExemploMailListID=2
ParâmetroMailListName
RequeridoSe (só por POST)
TipoNúmero Inteiro
ExplicaçãoCadeia de caracteres
ExemploMailListName=Minha lista de contatos

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de ingresso são incorretos, faltam ou são requeridos.
errorMsg_maillistNotFound
A lista solicitada não se encontra
errorMsg_maillistNotEdited
Não foi possível editar a lista de contatos

Estrutura de Saída:

maillist.MailListID
ID de lista de contato
maillist.MailListName
Nome da lista de contatos

** Só documentam-se os campos mais relevantes.

Módulo report

Este módulo agrupa serviços de relatórios. Úteis para saber o estado de avanço de envio de uma campanha ou as estatísticas de uma campanha.

1.Seguimento em tempo real

Serviço:

/report/livetrack

Informa o progresso de envio de uma campanha

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro
ExplicaçãoID de campanha
ExemploCampaignID=2
ParâmetroStatisticsID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID de envio. Caso este item não esteja presente, será considerado o último envio realizado (compatibilidade com versão anterior)
ExemploStatisticsID=4

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos
errorMsg_campaignNotFound
Não é possível encontrar campanha

Estrutura de Saída:

campaign.schedule.ScheduleStatus
Estado do envio. Possíveis valores [Pending|Preparing|Sending|Paused|Halted|Completed]
report.detailsOfSend.TotalSent
Total de e-mails enviados
report.detailsOfSend.TotalDelivered
Total de emails enviados menos los bounces blandos e duros
report.detailsOfSend.TotalRecipients
Total de contatos aos que é preciso enviar um correio

** Só documentam-se os campos mais relevantes.

2.Relatório geral

Serviço:

/report/livetrack

Informa o detalhe de uma campanha com todos seus possíveis envios. (os envios múltiplos de uma campanha se mantém por compatibilidade com um sistema anterior)

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro
ExplicaçãoID de campanha
ExemploCampaignID=2
ParâmetroStatisticsID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID de envio. Caso este item não esteja presente, será considerado o último envio realizado (compatibilidade com versão anterior)
ExemploStatisticsID=4

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos
errorMsg_campaignNotFound
Não é possível encontrar campanha
errorMsg_track
Erro indeterminado ao tentar obter um relatório

Estrutura de saída:

report.sendFilesDetail
Aponta a um serviço que retorna um ficheiro com o detalhe dos e-mails enviados
report.detailsOfSend.TotalSent
Aponta a um serviço que retorna um ficheiro com o detalhe dos e-mails enviados
report.detailsOfSend.TotalDelivered
Total de emails enviados menos los bounces blandos e duros
report.detailsOfSend.TotalRecipients
Total de contatos aos que é preciso enviar um correio
report.list.item.*
Atributos particulares de cada envio. Em geral só deve existir 1 envio.
report.campaign.Name
Nome da campanha
report.campaign.publicURL
URL para compartilhar os relatórios da campanha

** Só documentam-se os campos mais relevantes.

3.Relatórios distribuidos no tempo

Serviço:

/report/trackintime

Informa as leituras (únicas e totais) e cliques distribuidos no tempo. Recomenda-se usar Flot (http://code.google.com/p/flot/) para graficar este relatório

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro
ExplicaçãoID de campanha
ExemploCampaignID=2
ParâmetroStatisticsID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID de envio. Caso este item não esteja presente, será considerado o último envio realizado (compatibilidade com versão anterior)
ExemploStatisticsID=4

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos
errorMsg_campaignNotFound
Não é possível encontrar campanha

Estrutura de saída:

report.chart.UniqueReads
Pares [tick, valor] de leituras únicas
report.chart.Reads
Pares [tick, valor] de leituras únicas
report.chart.LinksClicks
Pares [tick, valor] de cliques em enlaces
report.chart.Ticks
Pares [tick, etiqueta]
report.campaign.CampaignID
ID de campanha
report.campaign.StatisticsID
ID de envio

** Só documentam-se os campos mais relevantes.

4.Relatório ressumido

Serviço:

/report/trackgraph

Relatório resumido de leituras, bounces, de cadastros, entregas de e-mails, etc. Se recomienda usar Flot (http://code.google.com/p/flot/) para graficar este relatório

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro
ExplicaçãoID de campanha
ExemploCampaignID=2
ParâmetroStatisticsID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID de envio. Caso este item não esteja presente, será considerado o último envio realizado (compatibilidade com versão anterior)
ExemploStatisticsID=4

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos
errorMsg_trackGraph
Erro indeterminado ao tentar obter um relatório

Estrutura de saída:

trackGraph.graph.Opened
Total de aberturas
trackGraph.graph.UniqueOpened
Total de aberturas únicas
trackGraph.graph.Clicks
Total de Cliques
trackGraph.graph.Bounces
Total de bounces
trackGraph.graph.Unsubscribed
Total de descadastros
trackGraph.graph.TotalDelivered
Total de e-mails enviados
trackGraph.graph.TotalRecipients
Total de destinatários
trackGraph.graph.StatisticsID
ID de envio

** Só documentam-se os campos mais relevantes.

5.Exportação de relatórios de leitura e cliques

Serviço:

/report/exportreads | /report/exportlinks

Gera um ficheiro csv com a informação de leituras (/report/exportreads) e cliques (/report/exportlinks) de uma campanha. Uma vez gerado o ficheiro CSV deverá ligar para o serviço "/download/export?FileToken=" para descarregá-lo

Parâmetros:

ParâmetroCampaignID
RequeridoSIM
TipoNúmero Inteiro
ExplicaçãoID de campanha
ExemploCampaignID=2
ParâmetroStatisticsID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID de envio. Caso este item não esteja presente, será considerado o último envio realizado (compatibilidade com versão anterior)
ExemploStatisticsID=4

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos
errorMsg_campaignNotFound
Não é possível encontrar campanha
errorMsg_exportDirNotWritable
Não é possível escrever o ficheiro a disco
errorMsg_reads
Erro indeterminado

Estrutura de saída:

report.campaign.Name
Nome da campanha
report.campaign.CampaignID
ID de campanha
report.campaign.StatisticsID
ID de envio
report.totalCount
Total de cadastros prosados
report.FileName
Nome do ficheiro gerado (a usar com /download/export)

** Só documentam-se os campos mais relevantes.

Caso você tenha interesse em aceder a mais relatórios ou tenha sugestões sobre novos relatórios, por favor entre em contato conosco.. https://administracion.donweb.com/clientes/index.php?modulo=soporte&archivo=asistente

Módulo administratoremail

Este módulo agrupa serviços de administração de listas de endereços de e-mail utilizados como remetente das campanhas e formulários de cadastro.

1.Seguimento em tempo real

Serviço:

/administratoremail/list

Listar endereços de correio eletrónico

Parâmetros:

Parâmetrocount
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoNúmero de cadastros como máximo por página
Exemplocount=10
Parâmetroabsolutepage
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoPágina de "count" de cadastros a que é solicitado ir. Se count vale 10 e absolutepage vale 3, então começaremos a ver desde o cadastro 31.
Exemploabsolutepage=3

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de ingresso são incorretos, faltam ou são requeridos.

Estrutura de Saída:

list.item.EmailID
ID do registro
list.item.EmailAddress
Endereço de correio eletrônico
list.item.Name
Etiqueta ou nome associado ao endereço de correio eletrônico
list.item.DkimPubKey
Chave pública da firma DKIM (só se estiver configurada)
list.item.DkimPrivKey
Chave privada da firma DKIM (só se estiver configurada)

** Só documentam-se os campos mais relevantes.

2.Criar ou Alterar a informação de um endereço de correio eletrônico

Serviço:

/administratoremail/edit

Recupere, crie ou edite os atributos de um endereço de e-mail. Se o chamado ao serviço for por GET, recupere a informação do cadastro solicitado. Se for por POST crie ou atualize (caso se ingresse o parâmetro EmailID) os dados do cadastro

Parâmetros:

ParâmetroEmailID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID de cadastro
ExemploEmailID=2
ParâmetroName
RequeridoSe (só por POST)
TipoCadeia de caracteres
ExplicaçãoEtiqueta ou nome associado ao endereço de correio eletrônico
ExemploName=Meu Nome
ParâmetroEmailAddress
RequeridoSe (só por POST)
TipoCadeia de caracteres
ExplicaçãoEndereço de correio eletrônico
ExemploEmailAddress=minombre@midominio.com
ParâmetroDkimPubKey
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoChave pública da firma DKIM
ExemploDkimPubKey=BEGIN PUBLIC KEY ######### END PUBLIC KEY
ParâmetroDkimPrivKey
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoChave privada da firma DKIM
ExemploDkimPrivKey=BEGIN RSA PRIVATE
KEY#######END RSA PRIVATE
KEY

Erros:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrectos, faltan o son requerido
errorMsg_administratorEmailNotFound
O cadastro solicitado não se encontra

Estrutura de saída:

email.EmailID
ID do registro
email.Name
Etiqueta ou nome associado ao endereço de correio eletrônico
email.EmailAddress
Endereço de correio eletrônico
email.DkimPubKey
Chave pública da firma DKIM
email.DkimPrivKey
Chave privada da firma DKIM
email.DNSRecord.name
Nome de host DNS (utilizado para a configuração de DKIM)
email.DNSRecord.value
Valor do cadastro (Utilizado para a configuração de DKIM)
email.DNSRecord.type
Tipo de cadastro da zona DNS (utilizado para a configuração de DKIM)
email.dkimIsValid
Confira se a configuração DKIM é válida

** Só documentam-se os campos mais relevantes.

3.Geração automática de Chaves DKIM

Serviço:

/administratoremail/genKey

Gere automaticamente um par de chaves para utilizar na configuração DKIM

Parâmetros:

Estrutura de saída:

openssl.public
Chave pública da firma DKIM
openssl.private
Chave privada da firma DKIM

** Só documentam-se os campos mais relevantes.

4.Conferir configuração DKIM

Serviço:

/administratoremail/testdkim

Verifique se a configuração da firma DKIM e a informação dos cadastros DNS sejam corretos e estejam atualizados

Parâmetros:

ParâmetroEmailID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID de cadastro
ExemploEmailID=2

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de ingresso são incorretos, faltam ou são requeridos.
errorMsg_administratorEmailNotFound
O cadastro solicitado não se encontra

Estrutura de saída:

email.EmailID
ID do registro
email.DNSRecord.name
Nome de host DNS (utilizado para a configuração de DKIM)
email.DNSRecord.value
Valor do cadastro (Utilizado para a configuração de DKIM)
email.dkimIsValid
Confira se a configuração DKIM é válida

** Só documentam-se os campos mais relevantes.

5.Deletar um endereço de correio eletrônico

Serviço:

/administratoremail/delete

Elimine logicamente um endereço eletrônico, o cadastro não estará disponível para sua visualização nos listados, mas poderá continuar sendo utilizado pelo sistema para garantir o correto funcionamento das campanhas que o utilizarem

Parâmetros:

ParâmetroEmailIds
RequeridoSIM
TipoArray de números inteiros
ExplicaçãoID dos cadastros que se deseja eliminar
ExemploEmailIds[]=2&EmailIds[]=5

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de ingresso são incorretos, faltam ou são requeridos.
errors.notDeleted
Array de IDs de cadastro que não foi possível eliminar

Estrutura de saída:

countDeleted
Número de cadastros eliminados satisfatoriamente
countNotDeleted
Número de cadastros que não foi possível eliminar

Módulo administrator

Este módulo agrupa serviços de administração de listas de endereços de e-mail utilizados como remetente das campanhas e formulários de cadastro.

1.Estado da conta do administrador

Serviço:

/administrator/status

Este serviço fornece a informação correspondente ao estado da conta do administrador como por exemplo: créditos disponíveis, tarefas programadas, processos de importação/exportação/exclusão de membros das listas de contatos, etc.

Parâmetros:

Estrutura de Saída:

credits.availableCredits
Quantidade de envíos disponíveis que possui o administrador
jobs.item[]
Array que contém todas as tarefas em segundo plano realizadas ou em processo

Cada um dos elementos do array contém os seguintes dados:

jobs.item[].BatchJobID
Identificador da tarefas
jobs.item[].UserID
Identificador do administrador
jobs.item[].Type
Tipo de tarea:
  • BatchMaillistImport / import:
    Importação de membros a listas
  • BatchSegment:
    Geração de lista segmentada
  • BatchMaillistOptimize:
    Otimização de lista
  • excluir:
    Exclusão de membros de listas
  • export:
    Exportação de listas
jobs.item[].Params
Parâmetros de ingresso da tarefa
jobs.item[].Response
Resposta da tarefa realizada ou em curso
jobs.item[].Progress
estado de avanço de 0 a 100
jobs.item[].Status
Descrição do estado atual da tarefa: por exemplo
jobs.item[].Status
Descrição do estado atual da tarefa: por exemplo.completed
jobs.item[].ErrorCode
Código de erro em caso de que exista
jobs.item[].CreationDate
Data de criação da tarefa
jobs.item[].LastUpdate
Data de última atualização da tarefa
jobs.item[].DeleteDate
Data de eliminação da tarefa

Módulo customfield

Este módulo agrupa serviços de administração dos campos personalizados utilizados para a informação dos contatos e os formulários de cadastro.

1.Listar campos personalizados

Serviço:

/customfield/list

Listar os campos personalizados. que foram configurados

Parâmetros:

Parâmetrocount
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoNúmero de cadastros como máximo por página
Exemplocount=10
Parâmetroabsolutepage
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoPágina de "count" de cadastros a que é solicitado ir. Se count vale 10 e absolutepage vale 3, então começaremos a ver desde o cadastro 31.
Exemploabsolutepage=3
Parâmetrofilter
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoNome ou parte do nome pelo que se filtram os cadastros
Exemplofilter=Promoção de Verão
ParâmetroorderBy
RequeridoNÃO
Tipo[name|id]
ExplicaçãoCampo pelo qual estará ordenado o listado
ExemploorderBy=Id
Parâmetrodesc
RequeridoNÃO
Tipo[1|0]
ExplicaçãoDetermine se a ordem do listado é ascendente (0) ou descendente (1)
Exemplodesc=1

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de entrada são incorretos, faltam ou são requeridos

Estrutura de Saída:

list.item.CustomFieldID
ID do cadastro (campo personalizado)
list.item.FieldType
Tipo de campo personalizado:
'Text field' Campo de texto
'Password field' Campo de senha
'Hidden field' Campo oculto
'Notice' Bloco informativo
'Text area' Campo de texto multi-linha
'Check box' Opções de seleção múltipla
'Radio button' Opções de seleção única
'List' Listado de seleção múltipla
'Drop list' Listado de seleção única
list.item.Validation
Tipo de validação de dados que aceita o campo:
'Do not Apply' Não validar (opção por default)
'Numeric Only' Aceitar só dígitos (sem espaços)
'Alpha Only' Aceitar só letras e espaços
'Alpha Numeric Only' Aceitar só letras, números e espaços
'Email Format Check' Aceitar só endereços de E-mail
'Custom' Personalizado (requer que seja configurada uma expressão regular personalizada de validação)
list.item.ValidationCustomRegExp
Expressão regular personalizada utilizada para validar os dados do campo
list.item.IsMultipleSelect
Indica se aceita valores múltiplos
list.item.Values.Option
Array de valores que o campo possui

2.Criar ou Alterar a informação de um campo personalizado

Serviço:

/customfield/edit

Recupera, cria ou edita os atributos de um campo personalizado. Caso o chamado ao serviço seja por GET, recupera a informação do cadastro solicitado. Caso seja por POST crie ou atualize (caso se ingresse o parâmetro CustomFieldID) os dados do cadastro

Parâmetros:

ParâmetroCustomFieldID
RequeridoNÃO
TipoNúmero Inteiro
ExplicaçãoID do registro
ExemploEmailID=2
ParâmetroTitle
RequeridoSe (só por POST)
TipoCadeia de caracteres
ExplicaçãoEtiqueta ou nome do campo personalizado
ExemploTitle=Color
ParâmetroFieldType
RequeridoSe (só por POST)
TipoCadeia de caracteres
ExplicaçãoTipo de campo personalizado
ExemploFieldType=List
ParâmetroValidation
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoTipo de validação de dados que aceita o campo
ExemploValidation=Custom
ParâmetroValidationCustomRegExp
RequeridoSi (Solo si el parámetro Validation es de tipo Custom)
TipoCadeia de caracteres
ExplicaçãoExpressão regular personalizada utilizada para validar os dados do campo
ExemploValidationCustomRegExp=/^[a-zA-Z0-9]*$/
ParâmetroDefaultValue
RequeridoNÃO
TipoCadeia de caracteres
ExplicaçãoValores por default que possui o campo (utilizado só em campos Text field, Password field, Text area, Notice y Hidden field)
ExemploDefaultValue=0800MyPhone
ParâmetroItemsNames
RequeridoNÃO
TipoArray
ExplicaçãoListado de etiquetas de opções do campo (utilizado só em campos tipo List, Drop list, Radio button e Check box) [ver nota]
ExemploItemsNames[]=Rojo&ItemsNames[]=Blanco
ParâmetroItemsValues
RequeridoNÃO
TipoArray
ExplicaçãoListado de valores das opções do campo (utilizado só em campos tipo List, Drop list, Radio button y Check box) [ver nota]
ExemploItemsValues[]=red&ItemsValues[]=white
ParâmetroItemsSelectedValues
RequeridoNÃO
TipoArray
ExplicaçãoListado das opções do campo marcadas como selecionadas (utilizado só em campos tipo List, Drop list, Radio buttony Check box)
ExemploItemsSelectedValues[]=white
ParâmetroItemsIsMultipleSelect
RequeridoNÃO
TipoInteiro [1|0]
ExplicaçãoIndica se o campo aceita múltiplos valores
ExemploItemsIsMultipleSelect=1

Nota: Os parâmetros ItemsNames eItemsValues estão relacionados entre si através da correspondência das chaves de ambos arrays. Ex. ItemsNames[5] possui a etiqueta da opção cujo valor encontra-se indicado em ItemsValues[5]

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de ingresso são incorretos, faltam ou são requeridos.
errorMsg_customfieldNotFound
O cadastro solicitado não se encontra

Estrutura de saída:

customField.CustomFieldID
ID do cadastro (campo personalizado)
customField.Title
Etiqueta/nome do campo
customField.FieldType
Tipo de campo personalizado
customField.Validation
Tipo de validação de dados que aceita o campo
customField.ValidationCustomRegExp
Expressão regular personalizada utilizada para validar os dados do campo
customField.IsMultipleSelect
Indica se aceita valores múltiplos
customField.Values.Option
Array de valores que o campo possui

** Só documentam-se os campos mais relevantes.

3.Deletar um campo personalizado

Serviço:

/customfield/delete

Elimine definitivamente um campo personalizado, o cadastro não estará mais disponível para sua utilização

Parâmetros:

ParâmetroCustomFieldIds
RequeridoSIM
TipoArray de números inteiros
ExplicaçãoID dos cadastros que se deseja eliminar
ExemploCustomFieldIds[]=2&CustomFieldIds[]=5

Erros:

errorMsg_formValidations
Um ou vários dos parâmetros de ingresso são incorretos, faltam ou são requeridos.
errors.notDeleted
Array de IDs de cadastro que não foi possível eliminar

Estrutura de saída:

countDeleted
Número de cadastros eliminados satisfatoriamente
countNotDeleted
Número de cadastros que não foi possível eliminar


Mensaje enviado con éxito
Ocurrió un error al enviar el mensaje.
Nuestros teléfonos
Formulario de contacto
Chatea con un asesor