Documentação universal para integrações

Assinaturas Eletrônicas Avançada e Qualificada

Padrão ICP-Brasil

Integração de operações via Web API (RESTful)

Versão 2.3.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 assinaturas da plataforma Finanblue Digital e qualquer sistema de informação que possibilite o consumo de Web APIs baseados no protocolo HTTP (RESTful).

Através desta integração as empresas poderão automatizar o processo de assinatura eletrônica para documentos e operações.

Possuímos documentações e APIs específicas para o segmento de crédito, bancos, fomento, entre outros mercados específicos. Para ter acesso a elas, fale com o seu consultor.

Integração de operações

A plataforma da Finanblue Digital provê um serviço Web baseado no protocolo HTTP (RESTful) para integração de qualquer tipo documento que necessite de assinaturas eletrônicas, o serviço esta exposto para consumo através dos Endpoints:

Web API – Restful:

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

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

Webservice – SOAP:

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

WSDL: https://www.gtidigital.com.br/webservices/documents?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.
id	Texto	64	Sim	Código alfanumérico para identificação da operação, gerado pela sua aplicação.
title	Texto	64	Sim	Informação definida no seu sistema para identificar a finalidade do processo.
description	Texto	2048	Sim	Informações para descrever a finalidade do processo.
notify	Boleano	-	Sim	Define se os signatários do processo serão notificados por e-mail após a integração do processo.
signers	Lista	-	Sim	Lista de Signatários.
signer	Objeto	-	Sim	Signatário do processo.
name	Texto	150	Sim	Nome do signatário.
cpf	Texto	18	Sim	CPF/CNPJ do signatário.
e-mail	Texto	150	Sim	E-mail do signatário.
function	Perfis		Sim	Funções do signatário. Ver Lista de Perfis.
sign	Boleano		Sim	Define se o signatário assinará os documentos.
certificate	Boleano		Sim	Define se o uso de certificados é obrigatório.
groups	Lista	-	Não	Lista de Grupos de Signatários (empresas).
group	Objeto	-	Sim	Grupos de Signatários.
name	Texto	150	Sim	Nome do grupo/empresa.
cnpj	Texto	18	Sim	CNPJ /CPF do grupo/empresa.
signers	Lista	-	Sim	Lista de Signatários.
signer	Objeto	-	Sim	Signatário do processo.
name	Texto	150	Sim	Nome do signatário.
cpf	Texto	18	Sim	CPF/CNPJ do signatário.
e-mail	Texto	150	Sim	E-mail do signatário.
function	Perfis		Sim	Funções do signatário. Ver Lista de Perfis.
sign	Boleano		Sim	Define se o signatário assinará os documentos.
certificate	Boleano		Sim	Define se o uso de certificados é obrigatório.
documents	Lista	-	Sim	Lista de Documentos para assinatura.
document	Objeto	-	Sim	Documento para assinatura.
filename	Texto	150	Sim	Nome do documento.
content	Base64	-	Sim	Conteúdo do documento.
signable	Boleano	-	Sim	Define se o documento é assinável.

Estrutura do JSON de Requisição

{

"apitoken": "string",

"user": "string",

"id": "string",

"title": "string",

"description": "string",

"notify": true,

"signers": [

{

"name": "string",

"cpf": "string",

"email": "string",

"function": 0,

"sign": true,

"certificate": true

}

"groups": [

{

"cnpjcpf": "string",

"name": "string",

"signers": [

{

"name": "string",

"cpf": "string",

"email": "string",

"function": 0,

"sign": true,

"certificate": true

}

]

}

"documents": [

{

"content": "string",

"signable": true,

"filename": "string"

}

]

}

TIPOS ESPECÍFICOS

Lista de Perfis

Perfil	Chave
Colaborador	0
Representante	1
Fiador/Avalista	2
Responsável Solidário	3
Procurador	4
Fiel Depositário	5
Presidente	6
Diretor	7
Devedor Solidário	8
Interveniente Garantidor Solidário	9
Testemunha	10
Sócio	11
Interventor Judicial	12
Avalista	13
Endossante	14
Emitente	15
Administrador	16
Representante da Administradora	30
Representante do Sacado	31
Gestor	41
Convidado	42
Validador	43
Representante Legal	44
Procurador/Consultoria	45
Interveniente	49
Investidor	96
Advogado	97
Contador	98
Outro	99

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.
processId	Guid	36	Retorna o id do processo criado na plataforma da Finanblue Digital.

Estrutura do JSON de resposta

{

"success": true,

"message": "string",

"processId": "string"

}

Mensagens de resposta

Propriedade	Tipo
Sucesso - documentos enviados com sucesso.	true
Falha - Usuário ou API Token inválido.	false
Falha - Dados do processo enviados incorretamente! Favor comunicar-se com administrador do sistema.	false
Falha - E-mail inválido para o signatário: {signer.Name} - {signer.Email}.	false
Falha - CPF inválido para o signatário: {signer.Name} - {signer.CPF}.	false
Falha - CPF/CNPJ inválido para o grupo: {group.Name} - {group.CnpjCpf}.	false
Falha - E-mail inválido para o signatário: {signer.Name} - {signer.Email}.	false
Falha - Nome inválido para o documento: {document.Filename}.	false
Falha - Conteúdo inválido para o documento: {document.Filename}.	false