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

A.R. on-line | e-mail monitorado

Versão 1.2.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 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 envio de e-mails que necessitem de monitoramento dos eventos, o serviço esta exposto para consumo através dos Endpoints:

Web API – Restful:

Endpoint URL: https://www.gtidigital.com.br/api/Email

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

Webservice – SOAP:

Endpoint URL: https://www.gtidigital.com.br/webservices/email

WSDL: https://www.gtidigital.com.br/webservices/email?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.
user Texto 150 Sim Email registrado como usuário da conta na plataforma GTI Digital.
subject Texto 64 Sim Assunto do e-mail.
body Texto 2048 Sim Corpo do e-mail.
from Objeto Sim Dados do remetente.
name Texto 150 Sim Nome do remetente.
email Texto 150 Sim E-mail do remetente.
tos Lista Sim Lista de Destinatários.
to Objeto Sim Destinatário do email.
name Texto 150 Sim Nome do Destinatário.
email Texto 150 Sim E-mail do Destinatário.
ccs Lista Não Lista de Destinatários (carbon copy).
cc Objeto Não Destinatário (carbon copy).
name Texto 150 Sim Nome do destinatário (carbon copy)
email Texto 150 Sim E-mail do destinatário (carbon copy)
ccos Lista Não Lista de Destinatários (blinde carbon copy).
cco Objeto Não Destinatário (blinde carbon copy).
name Texto 150 Sim Nome do destinatário (blinde carbon copy)
email Texto 150 Sim E-mail do destinatário (blinde carbon copy)
attachments Lista Sim Lista de anexos do e-mail.
attachment Objeto Sim Anexo do e-mail.
name Texto 150 Sim Nome do anexo.
content Base64 Sim Conteúdo do anexo.

Estrutura do JSON de Requisição

    {
        "apitoken": "string",
        "user": "string",
        "subject": "string",
        "body": "string",
        "from": {
            "name": "string",
            "email": "string"
        },
        "tos": [
            {
                "name": "string",
                "email": "string"
            }
        ],
        "ccs": [
            {
                "name": "string",
                "email": "string"
            }
        ],
        "ccos": [
            {
                "name": "string",
                "email": "string"
            }
        ],
        "attachments": [
            {
                "name": "string",
                "content": "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 erros.
msgid Texto 128 Retorna o Id do email enviado pela plataforma da GTI Digital.

Estrutura do JSON de resposta

    {
        "success": true,
        "message": "string",
        "msgid": "string"
    }

Mensagens de Resposta

Mensagem Sucesso
Sucesso – E-mail enviado com sucesso. true
Falha – Dados do enviados enviados incorretamente! Favor comunicar-se com administrador do sistema false
Falha – API Token incorreto! Favor comunicar-se com administrador do sistema. false
Falha – E-mail do Remetente {to.Name} é inválido: {to.Email}. false
Falha – E-mail não possui destinatários. false
Falha – E-mail do Remetente {cc.Name} é inválido: {cc.Email}. false
Falha – E-mail do Remetente {cco.Name} é inválido: {cco.Email}. false
Falha – Nome inválido para o documento em anexo: {attachment.name}. false
Falha – O conteúdo do anexo {attachment.Name} é inválido. false
Share on facebook
Share on twitter
Share on linkedin
Share on whatsapp
Share on email

Central de Ajuda

Encontre guias, manuais, tutoriais e diversos conteúdos para lhe ajudar.

Suporte por e-mail

Você poderá abrir chamados para o nosso time de suporte por e-mail.

Suporte por chat

O nosso time de suporte também poderá receber chamados por chat.

Suporte por telefone

No painel de controle você poderá acessar o nosso time de suporte por voz.

SLA de Atendimento

Prazos e tempos máximos de atendimento para cada tipo de caso e incidente.