Documentação para integrações com o serviço de A.R. on-line
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 Finanblue Digital e qualquer sistema de informação.
Integração para o monitoramento de e-mails
A plataforma da Finanblue 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 está 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 Finanblue Digital. |
user | Texto | 150 | Sim | E-mail registrado como usuário da conta na plataforma Finanblue 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. |
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. |
Texto | 150 | Sim | E-mail do Destinatário. | |
ccs | Lista | - | Não | Lista de Destinatários (carbon copy). |
cc | Objeto | - | Destinatário (carbon copy). | |
name | Texto | 150 | Sim | Nome do Destinatário (carbon copy). |
Texto | 150 | Sim | E-mail do Destinatário (carbon copy). | |
ccos | Lista | - | Não | Lista de Destinatários (blind carbon copy). |
cco | Objeto | - | Não | Destinatário (blind carbon copy). |
name | Texto | 150 | Sim | Nome do Destinatário (blind carbon copy). |
Texto | 150 | Sim | E-mail do Destinatário (blind 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. |
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 |
|---|---|---|---|
sucess | 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 da Finanblue 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 |
O Finanblue Watch é o Observatório de informações relevantes para os segmentos de crédito, financeiro, gestão de ativos e fomento comercial. Notícias, notas, tutoriais, legislação, normas e portarias são monitoradas pelo nosso time de especialistas e apresentadas neste ambiente.