API integração A.R. Online - Cartório Eletrônico

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 do sistema e qualquer sistema de informação.

Integração para o monitoramento de e-mails

O sistema 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 pelo sistema
user	Texto	150	Sim	E-mail registrado como usuário da conta plataforma
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
e-mail	Texto	150	Sim	E-mail do remetente
tos	Lista	–	Sim	Lista de destinatários
to	Objeto	–	Sim	Destinatário do e-mail
name	Texto	150	Sim	Nome do destinatário
e-mail	Texto	150	Sim	E-mail do destinatário
ccs	Lista	–	Não	Liesta de destinatários (carbon copy)
cc	Objeto	–	Não	Destinatário (carbon copy)
name	Texto	150	Sim	Nome do destinatário (carbon copy)
e-mail	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)
e-mail	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 e-mail enviado pela plataforma

Estrutura do JSON de Resposta

{

“success”: true,

“message”: “string”,

“msgid”: “string”

}

Dados retornados pela API

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