HISTÓRICO
Versão | Data da Publicação | Alterações |
---|---|---|
v1 | 14/03/2023 | - Primeira versão |
ÍNDICE
Introdução
O Fluxo de Assinaturas é o módulo da plataforma e-Notariado para a orquestração dos atos notariais eletrônicos.
Integração por API
Para obter os documentos assinados correspondentes aos atos eletrônicos orquestrados no Fluxo de Assinaturas, a plataforma e-Notariado disponibiliza algumas APIs para essa finalidade.
Para executar as APIs, é necessário obter a API-KEY correspondente do cartório.
O Tabelião deverá solicitar a API-KEY do ambiente de produção do Fluxo de Assinaturas do e-Notariado, enviando e-mail para servicos@notariado.org.br. A equipe do CNB providenciará a chave e responderá em seguida.
A mesma API-KEY deverá ser utilizada para todas as APIs a serem consumidas do Fluxo de Assinaturas
Postman Authorization
Type: API Key
Key: X-Api-Key
Value: <informar a API-KEY obtida com o CNB>
url: https://assinatura.e-notariado.org.br
Etapa 1 - Obter a lista dos atos do cartório
GET https://assinatura.e-notariado.org.br/api/documents
Parâmetros:
Parâmetro | Descrição | Conteúdo |
---|---|---|
IsConcluded | Indicativo de fluxo concluído | true, false |
IsCanceled | Indicativo de fluxo cancelado | true, false |
DocumentType | Tipo do documento | "Deed" - Escritura "PowerOfAttorney" - Procuração "TranscriptForPhysicalActs" - Traslado de ato físico "AcknowledgementForPhysicalActs" - Certidão de ato físico "AcknowledgmentForDigitalActs" - Certidão de ato eletrônico "PrivateDocument" - e-Not Assina "TravelPermit" - AEV "SignatureNotarizationTerm" - Termo do Reconhecimento de Firma por Autenticidade (TEC) |
Limit | Quantidade de resultados por execução | Ex.: 10 |
Offset | Offset do resultado | Ex.: 0 |
Order | Ordem do resultado | "asc" - ascedente "desc" - descendente |
Etapa 2 - Obter o detalhe de um determinado ato
GET https://assinatura.e-notariado.org.br/api/documents/{id}
sendo,
{id} - obtido no resultado da API da etapa 1
Etapa 3 - Obter o traslado assinado digitalmente de um ato eletr (PDF)
GET https://assinatura.e-notariado.org.br/api/documents/{id}/ticket/files/{fileId}
sendo,
{id} - obtido no resultado da API da etapa 1 e chave para a etapa 2
{fileId} - obtido no resultado da API da etapa 2, tag Files/id
Para baixar o PDF assinado, concatene a url com o conteúdo do resultado do processamento dessa API, campo Location.
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo