Comece por aqui
Introdução
Bem vindo a API Reference do LedgerDoc.
O LedgerDoc é uma plataforma de assinatura e preservação de documentos digitais (nativos ou não) da Empresa LedgerTec.
Ele é destinado a empresas ou pessoas físicas que desejam criar fluxos de assinatura e preservação de documentos digitais (nativos ou não).
Em determinados contextos, você ou sua empresa precisarão que o processo de assinatura digital seja realizado em seu sistema, integrado aos fluxos de trabalho já existentes. Para esses casos, disponibilizamos todos os componentes necessários para que você seja capaz de integrar o processo de assinatura digital dentro da sua plataforma.
Nessa seção você vai entender todos os passos necessários para utilizar nossa API.
Fluxo de assinatura
De forma resumida, o processo de assinatura ocorre em 3 etapas.
1º) Inicialização da assinatura
A primeira etapa, chamada de inicialização, consiste na preparação do documento para assinatura. Esta etapa é ralizada através de uma chamada à rota de inicialização da API de assinatura da LedgerTec.
2º) Aplicação de Algoritmo Criptográfico
O segundo passo consiste na aplicação de algorítimo criptográfico sobre o conteúdo do documento a partir da chave privada do certificado selecionado. Esta etapa é realizada através do LedgerSign, que é um plugin de navegador que permite o acesso a certificados digitais, estejam eles em token (A3) ou na própria máquina do cliente (A1), para a realização de assinatura digital dentro do navegador de internet.
3º) Finalização da assinatura
A terceira etapa é a finalização do documento. Esta etapa é realizada através de uma outra chamada à API de assinatura da LedgerTec, enviando também o valor gerado pela aplicação do algoritmo criptográfico na etapa anterior. O endpoint de finalização devolverá o documento assinado digitalmente.
A figura a seguir ilustra os 3 passos mencionados.
Pré-requisitos
Antes de continuar você vai precisar cumprir alguns requisitos para conseguir utilizar a api:
Criar uma conta
Para utilizar a API de assinatura Ledger é necessário criar uma conta na plataforma LedgerDoc.
Acesse o link https://doc2.ledgertec.com.br/registrar e realize o cadastro preenchendo todos os dados necessários.
Após a conclusão, verifique o e-mail informado no cadastro, para realizar a ativação da sua conta.
Gerar a sua chave de API
Para interagir com a API de assinatura Ledger (passos 1 e 3 do fluxo de assinatura) é necessário criar uma chave de API. Para isso, siga os seguintes passos:
1. Clique na sua foto no canto superior e acesse a opção "Chaves de API".
2. Em seguida, clique em "Criar" para gerar as chaves.
3. Preencha a descrição da chave e clique em Gerar Chave. (A descrição é apenas para seu controle, pois você pode ter múltiplas Chaves de API.
4. Por fim, copie e salve a chave em um lugar seguro. Ela nunca mais será exibida. Se não tiver mais posse de chave, será necessário criar uma nova. Recomendamos a exclusão de chaves perdidas.
caution
NÃO COMPARTILHE SUAS CHAVES DE API!
A sua chave de API é SECRETA e não deve ser compartilhada com terceiros nem muito menos ser utilizada no front da sua aplicação.
Integrar o LedgerSign
Para iniciar o processo de assinatura, você deve ter um certificado digital instalado em sua máquina, podendo ser um certificado de teste. Você precisará enviar o certificado para a API nas etapas 1 e 3 assim como precisará do certificado para a etapa 2. Para ter acesso a certificados digitais em sua aplicação web, é necessário ter instalado o LedgerSign.
O LedgerSign é um plugin de navegador que permite o acesso a certificados digitais, estejam eles em token (A3) ou na própria máquina do cliente (A1), para a realização de assinatura digital dentro do navegador de internet.
Clique aqui para seguir o passo a passo para a instalação do LedgerSign.
Com o LedgerSign instalado, você poderá importar certificados digitais e poderá ter acesso a tais certificados em sua aplicação através da biblioteca de integração.