Obter evidências
Sobre este guia
Através deste guia, demonstraremos como recuperar um conjunto de evidências de um documento assinado através de nossas APIs REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter um arquivo PDF com o conjunto de evidências.
Envelopes, documentos e evidências
Você já sabe, mas não custa lembrar: Um envelope possui um ou mais documentos. As evidências relacionam-se diretamente aos documentos e não aos envelopes.
O que você vai precisar
Antes de iniciar sua integração:
Certifique-se que você possui credenciais válidas para utilizar o Unico Sign. Se você ainda não possui suas credenciais, siga nosso guia de Primeiros Passos para configurar sua conta de teste e obter suas chaves de API.
Entenda os conceitos básicos sobre nosso produto. É extremamente importante que você entenda estes conceitos para fazer uma boa utilização das APIs do Unico Sign. Você pode encontrar nossos conceitos básicos neste guia.
Funcionamento básico
Como explicamos em nosso guia de conceitos básicos, Evidências servem para comprovar juridicamente a conformidade e validade de um envelope, documento ou assinatura.
Os elementos básicos de um conjunto de Evidências são:
Dados do emissor do envelope;
Dados do envelope (Id e Status);
Dados do documento original (Nome, Id e Hash SHA256 do documento);
Dados dos assinantes;
Dados do documento assinado (Nome, Id e Hash SHA256 da assinatura);
Logs dos eventos ocorridos no envelope.
Entenda a seguir, como obter um arquivo PDF com o conjunto de evidências de um documento já assinado:
Obtenha um token OAuth válido
Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após sua geração, o token de acesso deverá ser enviado no header de sua requisição, junto ao parâmetro Authorization.
Ambientes
Ao iniciar sua integração você receberá credenciais a nosso ambiente de homologação. Somente após o processo de testes e certificação você receberá credenciais de produção.
Você deverá apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo listamos as URLs de homologação e produção:
Ambiente de homologação:
https://signhom.acesso.io;Ambiente de produção:
https://sign.acesso.io.
Certifique-se que o documento tem um status válido
O documento de evidências está disponível apenas para os 3 status finais do fluxo de assinaturas: Concluído, recusado ou cancelado. Caso o documento não esteja em um desses formatos, você não conseguirá gerar o arquivo PDF.
Consulta do status
Caso o documento não esteja em um status considerado "final", retornaremos um erro HTTP 500.
import HttpMethod from '@site/src/components/HttpMethod';
Você pode consultar o status dos documentos através do método (GET/service/documents). Saiba mais sobre este método neste guia.
Faça uma requisição para o endpoint /evidence/
/evidence/Após gerar um token de acesso válido, faça uma requisição para o endpoint de geração de evidencias de nossa API REST (GET/service/evidence), especificando o documento ao qual deseja gerar as evidências como um parâmetro no path.
Abaixo um exemplo da requisição:
Não se esqueça de subsctituir o parâmetro DOCUMENT_UUID na requisição abaixo. Este parâmetro deve conter o UUID do documento ao qual você deseje gerar as evidências.
Exemplo de formato de um UUID: 00000000-0000-0000-0000-000000000000
Se tudo der certo em sua requisição, você receberá como resposta o arquivo binário do PDF.
Próximos passos
Conheça as funcionalidades disponíveis para o Gerenciamento de documentos.
Conheça as funcionalidades disponíveis para o Gerenciamento de envelopes.
Tendo problemas em nossa integração? Acesse nossa seção de FAQ e problemas comuns.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.
Atualizado