Pular para o conteúdo
  • Não há sugestões porque o campo de pesquisa está em branco.

Adicionar Rubrica no Documento (API)

Esta seção da API D4Sign permite que você adicione elementos visuais como assinaturas, rubricas ou selos em posições específicas dentro de um documento. Isso é fundamental para personalizar a aparência final do seu documento assinado.

🚧 Importante: Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.

Exemplo: https://secure.d4sign.com.br/api/v1/documents/{UUID-MAIN-DOCUMENT}/addpins?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Adicionar rubrica no documento (API)

Este endpoint irá adicionar um "pin" (assinatura, rubrica ou selo) na posição definida de um documento.

POST /documents/{UUID-MAIN-DOCUMENT}/addpins

Parâmetros de Requisição (URL)

Parâmetro

Descrição

UUID-MAIN-DOCUMENT

(obrigatório) O UUID do documento principal ao qual a rubrica será adicionada.
Exportar para as Planilhas

Parâmetros de Requisição (Body pins array)

Parâmetro

Descrição

document

(obrigatório) UUID do documento principal ou do documento anexo (slave) onde o pin será adicionado.

email

(obrigatório) E-mail do signatário que terá o pin adicionado. Este e-mail já deve pertencer a um signatário previamente adicionado ao documento.

page_width

(obrigatório) Largura da página do documento em pixels.

page_height

(obrigatório) Altura da página do documento em pixels.

page

(obrigatório) O número da página onde o pin será posicionado no documento selecionado no parâmetro document.

position_x

(obrigatório) Posição X (horizontal) da assinatura em pixels, a partir da esquerda da página.

position_y

(obrigatório) Posição Y (vertical) da assinatura em pixels, a partir do topo da página.

type

Tipo de pin a ser adicionado:
0 para assinatura <br> 1 para rubrica <br> 2 para selo
Requisição - Envio Header
 
JSON
 
{
    "Content-Type": "application/json"
}

{
    "Accept": "application/json"
}

Requisição - Envio Body

JSON 
{
  "pins": [
    {
      "document": "uuid-do-documento",
      "email" : "emaila@dominio.com.br",
      "page_width": 794,
      "page_height": 1123,
      "page": 1,
      "position_x": 397,
      "position_y": 560,
      "type": 1 
    }
  ]
}

Lembrando que o modelo acima segue o padrão de uma folha A4 retrato.

Para saber o UUID de um documento anexo (slave), é preciso fazer a seguinte requisição já apresentada anteriormente na documentação: GET /documents/{uuid-main-document}/listslaves

Como Identificar o Posicionamento no Documento

Para definir com precisão os valores de position_x e position_y, você precisará identificar as coordenadas exatas no seu documento. Uma forma comum de fazer isso durante o desenvolvimento é usando um script JavaScript para capturar a posição do cursor.

Ao visualizar o documento (por exemplo, dentro de um <iframe> ou elemento canvas), você pode usar o seguinte código no console do navegador para te ajudar a encontrar as coordenadas desejadas:

JavaScript 
var canvasElements = document.querySelectorAll("canvas");

canvasElements.forEach(function(canvasElement) {
    canvasElement.addEventListener("mousemove", function(event) {
        var rect = canvasElement.getBoundingClientRect();
        var posX = event.clientX - rect.left;
        var posY = event.clientY - rect.top;
        console.log("Posição do cursor: X=" + posX + " Y=" + posY);
    });
});

Este script irá logar no console do seu navegador as coordenadas X e Y do cursor cada vez que você mover o mouse sobre um elemento canvas. Assim, um desenvolvedor pode navegar visualmente até o ponto desejado no documento e anotar as coordenadas para usar na requisição da API.

Resposta Em caso de sucesso, a resposta retornará uma mensagem confirmando a operação.

JSON 
{
  "message": "success"
}

Após receber a mensagem de sucesso, atualize a tela de visualização do documento (viewblob) e o pin (rubrica, assinatura ou selo) deve estar na página e posição definida na requisição.