WebServices ALLINMAIL.
Com a intenção de facilitar a integração com a AllinMail, nós fornecemos soluções via WebServices,
abaixo você encontrará os principais webservices de nossa solução.
Documentação Login
http://painel01.allinmail.com.br/webservices/wsLogin.html
Entrada:
login: xsd: integer
senha: xsd:string
Saída:
Ticket que será usado na transação com outros webservices.
Documentação Upload de Base
http://painel01.allinmail.com.br/webservices/wsUploadBase.html
Url para efetuar Upload de Base
http://painel01.allinmail.com.br/webservices/wsUploadBase.html?document=1
Entrada:
ticket: xsd:string (Ticket retornado pela ws de Login)
nm_lista: xsd:string (Nome da Lista que irá receber a base)
arquivo: xsd:csv (Url do Arquivo CSV)
acao: xsd:integer (Aqui você informará se você deseja adicionar o arquivo a lista ou apagar a
lista e carregar o arquivo)
primeiraLinha: xsd:integer (Informar sempre o valor 1 )
separador: xsd:string (Aqui você informará o caractere de separação de colunas)
Saída:
Quantidade de e-mails encontrada na base.
Documentação Cadastrar Campanha
http://painel01.allinmail.com.br/webservices/wsCriarCampanha.html
Url para Cadastrar Campanha
http://painel01.allinmail.com.br/webservices/wsCriarCampanha.html?document=1
Entrada:
ticket: xsd:string (Ticket retornado pela ws de Login)
dados: xsd:array (nm_campanha (String com o nome da Campanha),
nm_subject (String com o Subject da Campanha),
nm_remetente (String com o email de remetente),
nm_remetente_nome (String com o nome de remetente),
nm_reply (String com o e-mail de resposta),
nm_html (String com o HTML em BASE64)
nm_txt (String com a versão texto da campanha),
view (Contabilizar abertura: 0 para não e 1 para sim) ,
click (Contabilizar clique: 0 para não e 1 para sim),
nm_filtro (String com o nome do Filtro que será utilizado),
ano_inicio (Inteiro com o ano de inicio da campanha),
mes_inicio (Inteiro com o mês de inicio da campanha),
dia_inicio (Inteiro com o dia de inicio da campanha),
ano_limite (Inteiro com o ano limite da campanha),
mes_limite (Inteiro com o mês limite da campanha),
dia_limite (Inteiro com o dia limite da campanha),
hora_inicio (String com a hora de inicio da campanha Ex:14),
minuto_inicio (String com o minuto de inicio da campanha Ex:59),
hora_limite(String com a hora de fim da campanha Ex:14),
minuto_limite (String com o minuto de fim da campanha Ex:59),
nm_categoria (String com o nome da categoria),
nm_lista (String com o nome da Lista),
fl_analytics (Integração com Analytics: 0 ou 1).
Retorno:
id_campanha (inteiro)
Documentação Editar Campanha
http://painel01.allinmail.com.br/webservices/wsEditarCampanha.html
Url para Editar Campanha
http://painel01.allinmail.com.br/webservices/wsEditarCampanha.html?document=1
ticket: xsd:string
id_campanha: xsd:inteiro
dados: xsd:array (nm_campanha (String com o nome da Campanha),
nm_subject (String com o Subject da Campanha),
nm_remetente (String com o email de remetente),
nm_remetente_nome (String com o nome de remetente),
nm_reply (String com o e-mail de resposta),
nm_html (String com o HTML em BASE64)
nm_txt (String com a versão texto da campanha),
view (Contabilizar abertura: 0 para não e 1 para sim) ,
click (Contabilizar clique: 0 para não e 1 para sim),
nm_filtro (String com o nome do Filtro que será utilizado),
ano_inicio (Inteiro com o ano de inicio da campanha),
mes_inicio (Inteiro com o mês de inicio da campanha),
dia_inicio (Inteiro com o dia de inicio da campanha),
ano_limite (Inteiro com o ano limite da campanha),
mes_limite (Inteiro com o mês limite da campanha),
dia_limite (Inteiro com o dia limite da campanha),
hora_inicio (String com a hora de inicio da campanha Ex:14),
minuto_inicio (String com o minuto de inicio da campanha Ex:59),
hora_limite(String com a hora de fim da campanha Ex:14),
minuto_limite (String com o minuto de fim da campanha Ex:59),
nm_categoria (String com o nome da categoria),
nm_lista (String com o nome da Lista),
fl_analytics (Integração com Analytics: 0 ou 1).
Documentação Listas Campanhas
http://painel01.allinmail.com.br/webservices/wsListarCampanhas.html
Url para Listas Campanhas
http://painel01.allinmail.com.br/webservices/wsListarCampanhas.html?document=1
Este webservices ao informar apenas o ticket, você terá como retorno a lista de campanhas na caixa de
montadas, informando um segundo parâmetro que seria o id_campanha, você verá os dados
cadastrados nessa campanha. Caso queira enviar um teste de alguma campanha, você pode passar o
parâmetro ação que tem como opção a string "Excluir" ou "Teste" ou "Final" , caso você informa o
valor teste, torna-se necessário um outro parâmetro que será o email que receberá o teste.
Documentação Campanhas Encerradas
http://painel01.allinmail.com.br/webservices/wsCampanhasEncerradas.html
Url para Campanhas Encerradas
http://painel01.allinmail.com.br/webservices/wsCampanhasEncerradas.htm?document=1
Entrada:
ticket: xsd:string
mes: xsd:string (O mês que você quer pesquisar)
ano: xsd:string (O Ano que você quer pesquisar)
Saída: Array com a lista de campanhas.
Documentação Caixa de Saída
http://painel01.allinmail.com.br/webservices/wsCampanhaCxSaida.html
Url para Caixa de Saída
http://painel01.allinmail.com.br/webservices/wsCampanhaCxSaida.html?document=1
Este webservices ao informar apenas o ticket, você terá como retorno a lista de campanhas na caixa de
saída, informando um segundo parâmetro que seria o id_campanha, você verá os dados cadastrados
nessa campanha. Caso queira enviar um teste de alguma campanha, você pode passar o parâmetro ação
que tem como opção a string "Excluir" ou "Teste" ou "Pause" ou “Play”. Caso você informe o
valor teste, torna-se necessário outro parâmetro que será o email que receberá o teste.
Documentação Relatório da campanha
http://painel01.allinmail.com.br/webservices/wsRelatorio.html
Url Relatório da campanha
http://painel01.allinmail.com.br/webservices/wsRelatorio.html?document=1
Entrada:
ticket: xsd:string
id_campanha: xsd:array
Saída: Array de dados com todos os dados que temos disponíveis do relatório de campanha.