Documentação para integração com o serviço de consulta dos status das assinaturas eletrônicas
Versão 1.0.1
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 consulta dos status das assinaturas da Finanblue Digital e qualquer sistema de informação.
Integração para a consulta dos status
A plataforma da Finanblue Digital provê um serviço Web baseado no protocolo HTTP (RESTful) para consulta dos status das assinaturas, o serviço esta exposto para consumo através dos Endpoints:
Web API – Restful:
Endpoint URL (GET): https://www.gtidigital.com.br/api/Documents
Swagger: https://www.gtidigital.com.br/swagger/ui/index#!/Documents/Documents_Get
Webservice – SOAP:
Endpoint URL: https://www.gtidigital.com.br/webservices/ProcessStatus.asmx
WSDL: https://www.gtidigital.com.br/webservices/ProcessStatus.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 Finanblue Digital. |
processId | Texto | 36 | Sim | Id do processo retornado pela API de envio de documentos. |
Estrutura do JSON de Requisição
{
"apitoken": "string",
"processId": "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. |
process | Objeto | - | Dados do processo enviado pela plataforma Finanblue Digital. |
processId | Texto | 36 | Id do processo retornado pela API de envio de documentos. |
process | Texto | - | Descrição do processo. |
status | Texto | - | Status do processo. |
sendDate | Data | - | Data e hora do envio do processo. |
completionDate | Data | - | Data e hora da conclusão do processo. |
signatures | Inteiro | - | Quantidade de assinaturas do processo. |
timestamps | Inteiro | - | Quantidade de carimbos do tempo das assinaturas do processo. |
documents | Lista | - | Lista de Documentos do processo. |
document | Objeto | - | Documento do processo. |
filename | Texto | - | Nome do documento. |
category | Texto | - | Categoria do documento. |
signatures | Inteiro | - | Quantidade de assinaturas do documento. |
timestamps | Inteiro | - | Quantidade de carimbos do tempo das assinaturas do documento. |
groups | Lista | - | Lista de Grupos/Empresas do processo. |
group | Objeto | - | Grupo/Empresa do processo. |
cnpjcpf | Texto | - | CNPJ ou CPF do Grupo/Empresa. |
name | Texto | - | Nome do Grupo/Empresa. |
signers | Lista | - | Lista de signatários do Grupo/Empresa. |
signer | Objeto | - | Signatário do Grupo/Empresa. |
name | Texto | - | Nome do Signatário. |
cpf | Texto | - | CPF ou CNPJ do Signatário. |
Texto | - | E-mail do Signatário. | |
function | Inteiro | - | Perfil do Signatário. |
status | Inteiro | - | Status do Signatário. |
signatures | Inteiro | - | Quantidade de assinaturas do Signatário. |
timestamps | Inteiro | - | Quantidade de carimbos do tempo das assinaturas do signatário. |
Estrutura do JSON de resposta
{
"success": true,
"message": "string",
"process": {
"processId": "00000000-0000-0000-0000-000000000000",
"process": "string",
"status": 0,
"sendDate": "2021-03-17T03:36:36.400Z",
"completionDate": "2021-03-17T03:36:36.400Z",
"signatures": 0,
"timestamps": 0,
"documents": [
{
"filename": "string",
"category": 0,
"signatures": 0,
"timestamps": 0
}
],
"groups": [
{
"cnpjcpf": "string",
"name": "string",
"signers": [
{
"function": 0,
"status": 0,
"name": "string",
"cpf": "string",
"email": "string",
"signatures": 0,
"timestamps": 0
}
]
}
]
}
}
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.