Documentação para integrações com o serviço de Status do A.R. on-line

 

Versão 1.0.0

Caso necessite de algum suporte sobre esta documentação, fale com o seu consultor.

Introdução

Este manual de integração define as especificações e critérios técnicos necessários para integração entre o serviço de Status do A.R. on-line da GTI Digital e qualquer sistema de informação.

Integração para o monitoramento de e-mails

A plataforma da GTI Digital provê um serviço Web baseado no protocolo HTTP (RESTful) para consulta dos Status dos eventos do monitoramento de e-mails, o serviço esta exposto para consumo através dos Endpoints:

Web API – Restful:

Endpoint URL (GET): https://test.gtidigital.com.br/api/Email

Swagger: https://www.gtidigital.com.br/swagger/ui/index#!/Email/Email_Get

Webservice – SOAP:

Endpoint URL: https://test.gtidigital.com.br/webservices/EmailStatus.asmx

WSDL: https://test.gtidigital.com.br/webservices/EmailStatus.asmx?WSDL

A estrutura de dados esperados para requisição destes serviços está descrita a seguir.

Estrutura dos dados da requisição à API

Propriedade Tipo Tamanho Obrigatório Descrição
apitoken Texto 64 Sim Token de validação gerado pela GTI Digital.
msgid Texto 1024 Sim Id da mensagem retornado pela API de envio de e-mails.

Estrutura do JSON de Requisição

    {
        "apitoken": "string",
        "msgid": "string"
    }

Dados retornados pela API

Propriedade Tipo Tamanho Descrição
success Boleano Indica se o retorno foi bem sucedido.
message Texto Exibe uma mensagem contendo a descrição dos status e/ou erros.
email Objeto Dados do email enviado pela plataforma GTI Digital.
msgid Texto 1024 Id da mensagem retornado pela API de envio de e-mails.
from Texto E-mail do remetente.
to Texto Endereços de e-mail dos destinatários.
cc Texto Endereços de e-mail dos destinatários (carbon copy).
sendDate Data Data de envio do e-mail.
score Inteiro Score da mensagem enviada.
events Lista Lista de Eventos do e-mail monitorado.
event Objeto Evento do e-mail monitorado.
eventType Texto Descrição do tipo de evento do e-mail monitorado
date Data Data de ocorrência do evento do e-mail monitorado
emailRecipient Texto E-mail do destinatário relacionado ao evento do e-mail monitorado

Estrutura do JSON de resposta

    {
        "success": true,
        "message": "string",
        "email": {
            "msgid": "string",
            "from": "string",
            "to": "string",
            "cc": "string",
            "sendDate": "string",
            "score": 0,
            "events": [
                {
                    "eventType": "string",
                    "date": "string",
                    "emailRecipient": "string"
                }
            ]
        }
    }