Inicializar assinatura

Autorização Basic Auth

Para se autenticar conosco você deve enviar a Chave de API, gerada no passo anterior, no campo apiKey dentro do cabeçalho JSON da requisição:

{
    "apiKey":"SUA CHAVE DE API",
    ...
}

Inicializar assinatura

Essa é a primeira etapa para assinar um documento no formato PDF. Você deve enviar todos os campos obrigatórios no JSON para conseguir o Hash e o Timestamp que irá utilizar nas próximas etapas.

https://ledgertec.com.br/api/sign-service/pdf-service/v2/initialize

apiKey* Obrigatóriostring(header)

Chave de api enviada no cabeçalho da requisição.

certificate* Obrigatório(formData)

Certificado Base64 x509 codificado

file* Obrigatóriofile(formData)

Arquivo a ser assinado

hashAlgorithm* Obrigatório(formData)

Algoritmo de hash usado para executar o resumo
Valores disponíveis: SHA256

signatureField(formData)

Campo de contêiner para elemento de assinatura

signatureFieldPage(formData)

Página de campo de assinatura. Obrigatório se enviar signatureField
Valor padrão: 0

signaturePolicy* Obrigatório(formData)

Política de assinatura conforme ICP Brasil DOC-ICP-15.03
Valores disponíveis: RB, RT, RC, RA

signaturePolicyVersion* Obrigatório(formData)

Versão da política de assinatura de acordo com ICP Brasil DOC-ICP-15.03
Valores disponíveis: 1,1, 1,2

visualSignatureDateTime(formData)

Inserir data e hora na assinatura de texto
Valores disponíveis: true, false
Valor padrão: false

visualSignatureFilefile(formData)

Arquivo de assinatura visual

visualSignatureHeight(formData)

Altura da assinatura visual

visualSignatureLayout(formData)

Layout para assinatura visual Valores disponíveis:
1 - Imagem centralizada, texto abaixo.
2 - Imagem do lado esquerdo, texto do lado direito,
3 - Imagem do lado direito, texto do lado esquerdo,
4 - Texto centralizado, imagem abaixo
Valor padrão: 1

visualSignaturePositionX(formData)

Posição X para assinatura visual

visualSignaturePositionY(formData)

Posição Y para assinatura visual

visualSignatureText(formData)

Texto a ser exibido com a assinatura

visualSignatureTextAlignment(formData)

Alinhamento horizontal de assinatura visual
Valores disponíveis: CENTER, LEFT
Valor padrão: CENTER

visualSignatureTextFontSize(formData)

Tamanho da fonte da assinatura visual
Valor padrão: 8

visualSignatureWidth(formData)

Largura da assinatura visual

Exemplo de Requisição:

csharp-RestSharpcurl-cURLgo-Nativehttp-HTTPjava-OkHttpjava-Unirestjavascript-Fetchjavascript-jQueryjavascript-XHRc-libcurlnodejs-Axiosnodejs-Nativenodejs-Requestnodejs-Unirestocaml-Cohttpphp-cURLphp-Guzzlephp-HTTP_Request2php-pecl_httppowershell-RestMethodpython-http.clientpython-Requestsr-httrr-RCurlruby-Net::HTTPshell-Httpieshell-wgetswift-URLSession

javascript-Fetch

var myHeaders = new Headers();
myHeaders.append("apiKey", "{{apikey}}");
myHeaders.append("Content-Length", "");

var formdata = new FormData();
formdata.append("nonce", "1");
formdata.append("certificate", "{{certificate}}");
formdata.append("hashAlgorithm", "SHA256");
formdata.append("signaturePolicy", "RT");
formdata.append("signaturePolicyVersion", "1.1");
formdata.append("file", fileInput.files[0], "/path/to/file");
formdata.append("visualSignatureFile", fileInput.files[0], "/path/to/file");
formdata.append("visualSignaturePositionX", "200");
formdata.append("visualSignaturePositionY", "400");
formdata.append("visualSignatureWidth", "400");
formdata.append("visualSignatureHeight", "241");
formdata.append("visualSignatureText", "Signer Name");
formdata.append("signatureField", "signature_id");
formdata.append("signatureFieldPage", "0");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: formdata,
   redirect: 'follow'
};

fetch("https://ledgertec.com.br/api/sign-service/pdf-service/v2/initialize", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

Exemplo de Resposta:

Resposta

{
  "signingTime": "1652640934991",
  "dataToSign": "PGRzOlNpZ...Y2U+PC9kczpTaWduZWRJbmZvPg==",
  "error": ""
}

O valor retornado em signingTime deverá ser enviado em campo de mesmo nome no endpoint de finalização.

O campo dataToSign contém um encode dos dados, incluindo o hash que representa o conteúdo do arquivo e que será utilizado na etapa 2 para a aplicação da chave criptográfica

Erros

A nossa API valida cada um dos campos enviados na requisição antes de prosseguir.

Utilizamos os códigos de resposta convencionais do HTTP para indicar o sucesso ou a falha de uma requisição. Sendo assim, códigos 2xx indicam sucesso, 4xx indicam erros por algum dado informado incorretamente (por exemplo, algum campo obrigatório não enviado ou um cartão sem data de validade) e 5xx indicando erros nos servidores do LedgerDoc.

---

Tabela dos HTTP Status Code

Código	Status
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found