Email API Web Service

Versão: 4.00 Última Atualização: 13/10/2015

Índice

1. Introdução
2. Enviando mensagens via Email
3. Obtendo os eventos do Email

1. Introdução

Seguindo a documentação presente nesta página, você irá conseguir integrar o seu sistema com o Gateway de Email do PitchWink! Para começar de pé direito, sugerimos que você leia os requerimentos, as notas importantes (onde comunicamos novidades e mudanças futuras) e as descrições de cada método. Desta forma, você irá ganhar tempo e conhecer a solução como um todo. Em caso de dúvida, estamos aqui para ajudá-lo! Acesse sua conta, crie um ticket de suporte e entre em contato conosco. Divirta-se integrando!

1.1. Requerimentos

É necessário ter acesso a “Credencial” e “Token” da sua conta para realizar a integração. Estes dados podem ser encontrados no menu de “Configurações”, opção “Dados de Integração”.

1.2. URL do Web Service

http://pw-api.com/e-mail/service.asmx

1.3. Notas importantes

1 A próxima versão irá conter as seguintes funcionalidades:

• Consulta por intervalo de data
• Consulta de saldo de créditos

2. Enviando mensagens via Email

O MPG_Send_Email é o método que permite o envio de mensagens via email através do nosso Gateway.

2.1. Método MPG_Send_Email

2.2. Descrição do PARAMETERS

Este parâmetro é uma string que contém os seguintes campos abaixo, separados por pipe (|)

2.3. Retornos do MPG_Send_Email

2.4. Exemplo

Imports Namespace_Webservices_Email
 
Partial Class _Default
    Inherits System.Web.UI.Page
 
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
        Dim v_st_Status As String = String.Empty
        Dim v_st_Ret As String = String.Empty
        Dim v_st_Param As String = String.Empty
        ' ------------------------------
        ' Instanciando a Classe de Email
        ' ------------------------------
        Dim v_obj_Gateway As New MPGatewayEmail
        Dim v_st_Assunto As String = String.Empty
        Dim v_st_Corpo As String = String.Empty
        '
        v_st_Assunto = "Assunto"
       v_st_Corpo = System.Web.HttpUtillity.UrlDecode("Corpo do Email")
        v_st_Param = "4.00|CREDENCIAL|TOKEN||WEBAPI|Aux_User|abc@PitchWink.com|Nome FROM|abc@outlook.com||" & v_st_Assunto & "|HTML|" & v_st_Corpo        
	v_st_Ret = v_obj_Gateway.MPG_Send_Email("TXT", v_st_Param)
        '
        Response.Write(v_st_Ret)
    End Sub
End Class

3. Obtendo os eventos do Email

O MPG_ID_Email_Events é o método que retorna os eventos de um email.

3.1. Método MPG_ID_Email_Events

3.2. Descrição do PARAMETERS

Este parâmetro é uma string que contém os seguintes campos abaixo, separados por pipe (|)

3.3. Retornos do MPG_ID_Email_Events (JSON)

Com erro. Exemplo: { “error” : “019” }

{ "error":"$error" }

Retorno dos eventos

      { 
          "events": [ 
              { 
                 "code" : "xxxxx",
                 "name": "xxxxxxxxxxxxxxxxxxxxxxxxxxx", 
                 "date_event": "YYYY-MM-DD HH:MM:SS",  
                 "event_description": "xxxxxxxxxxxxxxxxxxxx..." 
     
              }, 
              { 
                 "code" : "xxxxx",
                 "name": "xxxxxxxxxxxxxxxxxxxxxxxxxxx", 
                 "date_event": "YYYY-MM-DD HH:MM:SS", 
                 "event_description": "xxxxxxxxxxxxxxxxxxxx..." 
              } 
          ] 
      }

3.4. Status de Retorno do Email

3.5. Exemplo em VB.NET

Imports Namespace_Webservices_Email
 
Partial Class _Default
    Inherits System.Web.UI.Page
 
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
        Dim v_st_Status As String = String.Empty
        Dim v_st_Ret As String = String.Empty
        Dim v_st_Param As String = String.Empty
        ' ------------------------------
        ' Instanciando a Classe de Email
        ' ------------------------------
        Dim v_obj_Gateway As New MPGatewayEmail
        Dim v_st_Assunto As String = String.Empty
        Dim v_st_Corpo As String = String.Empty
        '
        v_st_Assunto = "Assunto"
         v_st_Corpo = System.Web.HttpUtillity.UrlDecode("Corpo do Email") v_st_Param = "4.00|CREDENCIAL|TOKEN||WEBAPI|Aux_User|abc@PitchWink.com|Nome FROM|abc@outlook.com||" & v_st_Assunto & "|HTML|" & v_st_Corpo        
	v_st_Ret = v_obj_Gateway.MPG_Send_Email("TXT", v_st_Param)
        '
        Response.Write(v_st_Ret)
    End Sub
End Class