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

Upload de um Documento a partir de Template HTML (API)

Este endpoint da API D4Sign permite que você gere um novo documento em seu cofre utilizando um template HTML previamente configurado. É uma forma flexível de criar documentos personalizados, preenchendo campos dinâmicos com dados da sua aplicação.

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

Exemplo de URL completa para requisição: https://secure.d4sign.com.br/api/v1/documents/{UUID-SAFE}/makedocumentbytemplate?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Header

O cabeçalho da sua requisição deve conter o Content-Type como application/json, além dos seus tokens de autenticação.

JSON
{
    "Content-Type": "application/json",
    "tokenAPI": "{SEU-TOKEN-API}",
    "cryptKey": "{SUA-CRYPT-KEY}"
}

Body

No corpo da requisição, você enviará o nome do documento, o UUID de uma pasta opcional e um objeto templates contendo o ID do template e as variáveis a serem preenchidas.

JSON
{
    "name_document": "TESTE AGORA",
    "templates": {
        "ND1z1DE=": {
            "E-mail": "email@d4sign.com.br",
            "Profissão": "Analista de Sistemas",
            "Endereço": "Rua das Flores, 123",
            "Bairro": "Jardim América",
            "Cidade": "São Paulo",
            "Estado": "SP",
            "CEP": "01234-567",
            "VELOCIDADE/PLANO": "500MB Fibra Ótica",
            "VALOR": "R$ 99,90",
            "00/00": "01/08/2025",
            "XX/XX": "30/08/2025"
        }
    }
}

Detalhes dos Parâmetros do Body:

Parâmetro Tipo Obrigatoriedade Descrição
name_document String Opcional Define o nome do documento que será criado. Se não for preenchido, o documento terá o nome "Documento".
uuid_folder String Opcional Para que o documento fique armazenado dentro de uma pasta específica, informe o UUID dela. Se não for preenchido, o documento será salvo no cofre informado na requisição.
templates Objeto Obrigatório Um objeto que contém os templates a serem usados. A chave é o ID do template (ex: "MzE="), e o valor é um objeto com as variáveis personalizadas (ex: "NOME_CLIENTE": "João") que serão preenchidas no template. Lembre-se de informar pelo menos um template. As variáveis dos campos personalizados (como "NOME_CONTRATANTE") devem ser informadas exatamente como estão cadastradas.

Resposta (Status 200 - Sucesso)

Quando a requisição for bem-sucedida, você receberá um JSON com o UUID do documento recém-criado.

JSON
{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}

🚧 Observações Importantes:

  • Diferencia Maiúsculas e Minúsculas: O sistema é sensível a maiúsculas e minúsculas para os nomes das variáveis. Certifique-se de respeitar a capitalização exata (ex: NOME_CONTRATANTE é diferente de nome_contratante).

  • Permissões Necessárias: Para criar documentos em um cofre compartilhado a partir de um template HTML, o usuário da API precisa ter as permissões de acesso "Administrador" ou "Padrão" no cofre específico.