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 Word (API)

Este endpoint da API D4Sign é o que você precisa para criar um novo documento no seu cofre, usando como base um template Word (.docx) previamente configurado na plataforma. É super útil para automatizar a geração de documentos padronizados, preenchendo as variáveis de forma dinâmica.

🚧 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}/makedocumentbytemplateword?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ê vai enviar um objeto JSON com as informações necessárias para criar o documento, como o ID do template e os valores para as variáveis.

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
id_template String Obrigatório O ID do template Word que você quer usar para gerar o documento. Você pode obter esse ID através do endpoint de listar templates. Lembre-se: é preciso informar pelo menos um template.
variables Objeto Opcional Um objeto JSON onde a chave é o nome da variável no seu template Word e o valor é o dado que você quer inserir. Por exemplo, se no seu template você tem uma variável , aqui você passaria "NOME_CLIENTE": "João".
name_document String Opcional Define o nome do documento que será criado no D4Sign. Se você não preencher, o documento será salvo com o nome padrão "Documento".
uuid_folder String Opcional Se você quiser que o documento seja armazenado dentro de uma pasta específica, informe o UUID dela aqui. Caso contrário, o documento será salvo diretamente no cofre informado na URL da requisição.

Resposta (Status 200 - Sucesso)

Quando a requisição for bem-sucedida, você receberá um JSON com o uuid do documento recém-criado, que é o identificador único dele.

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

🚧 Observações Importantes:

  • Case Sensitive: As variáveis dos campos personalizados (ex: NOME_CLIENTE, CPF) precisam ser informadas exatamente iguais ao que está cadastrado no seu template Word. O sistema é case sensitive, ou seja, ele diferencia letras maiúsculas de minúsculas.

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