Endpoints Documentos

Endpoints Documentos

🚧

Importante

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

Ex.: https://secure.d4sign.com.br/api/v1/safes?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Listar todos os documentos

GET/documents

Testar endpoint 🧪

📘

O resultado será de 500 documentos por páginas
Utilize o parametro PG na URL para paginar o resultado. Ex.:
https://secure.d4sign.com.br/api/v1/documents?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2
O primeiro bloco do resultado exibirá o total de páginas disponíveis

Requisição

{
    "Content-Type": "application/json"
}
[{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "teste.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Atendimento",
    "statusId": "3",
    "statusName": "Aguardando Assinaturas",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento"
},
{...}]

Listar um documento específico

GET /documents/{UUID-DOCUMENT}

Testar endpoint 🧪

Esse objeto retornará apenas o documento solicitado.

{
    "Content-Type": "application/json"
}
{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "teste.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Atendimento",
    "statusId": "3",
    "statusName": "Aguardando Assinaturas",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento"
}
ParâmetroDescrição
UUID-DOCUMENTO (obrigatório)UUID do documento que deverá ser listado.

Listar todos os documentos de uma fase

GET /documents/{ID-FASE}/status

Testar endpoint 🧪

Esse objeto retornará todos os documentos que estiverem na fase informada.

📘

O resultado será de 500 documentos por páginas
Utilize o parâmetro PG na URL para paginar o resultado. Ex.:
https://secure.d4sign.com.br/api/v1/documents?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2

O primeiro bloco do resultado exibirá o total de páginas disponíveis

{
    "Content-Type": "application/json"
}
{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "teste.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Atendimento",
    "statusId": "3",
    "statusName": "Aguardando Assinaturas",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento"
}
ParâmetroDescrição
ID-FASE (obrigatório)ID da FASE que deverá ser listado.
ID 1 - Processando
ID 2 - Aguardando Signatários
ID 3 - Aguardando Assinaturas
ID 4 - Finalizado
ID 5 - Arquivado
ID 6 - Cancelado
ID 7 - Editando

UPLOAD de um documento principal

POST /documents/{UUID-SAFE}/upload

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento para os servidores da D4Sign.

🚧

Atenção!

Após o UPLOAD, o documento será criptografado em nossos cofres e carimbado com um número de série.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

Todos os documentos ficam armazenados em COFRES criptografados, ou seja, o parâmetro UUID-SAFE é obrigatório e determina em qual cofre o documento ficará armazenado.

{
    "Content-Type": "multipart/form-data;",
    "tokenAPI": "{token-user}"
}
{
    "file": "FILE(form-data)",
    "uuid_folder": "{UUID DA PASTA}"
}
{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}
ParâmetroDescrição
File (obrigatório)Arquivo que será enviado para os servidores da D4Sign. MIME Types aceitos PDF,DOC,DOCX,JPG,PNG,BMP
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.

UPLOAD de um documento anexo ao principal

POST/documents/{UUID-DOC-PRINCIPAL}/uploadslave

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento para os servidores da D4Sign e ficará anexo ao documento principal.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

{
    "Content-Type": "multipart/form-data;",
    "tokenAPI": "{token-user}"
}
{
    "file": "FILE(form-data)"
}
{
    "message": "File created"
}
ParâmetroDescrição
File (obrigatório)Arquivo que será enviado para os servidores da D4Sign. MIME Types aceitos PDF,DOC,DOCX,JPG,PNG,BMP

UPLOAD de um documento principal (Binário)

POST/documents/{UUID-SAFE}/uploadbinary

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento para os servidores da D4Sign.

Após o UPLOAD, o documento será criptografado em nossos cofres e carimbado com um número de série.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

Todos os documentos ficam armazenados em COFRES criptografados, ou seja, o parâmetro UUID-SAFE é obrigatório e determina em qual cofre o documento ficará armazenado.

{
    "base64_binary_file": "JVhsdCAdwesAD2dsadfASDQW...",
    "mime_type": "application/pdf",
    "name": "Meu contrato de venda",
    "uuid_folder": "{UUID DA PASTA}"
}
{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}
ParâmetroDescrição
base64_binary_file (obrigatório)Arquivo que será enviado para os servidores da D4Sign. ATENÇÃO: Você deve enviar o binário do seu arquivo codificado em BASE64
mime_type (obrigatório)Informe o MIMETYPE do seu arquivo
name (opcional)Informe o nome do seu arquivo
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.

UPLOAD de um documento anexo ao principal (Binário)

POST/documents/{UUID-DOC-MASTER}/uploadslavebinary

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento para os servidores da D4Sign.

Após o UPLOAD, o documento será criptografado em nossos cofres e carimbado com um número de série.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

{
    "base64_binary_file": "JVhsdCAdwesAD2dsadfASDQW...",
    "mime_type": "application/pdf",
    "name": "Meu contrato de venda"
}
{
    "message": "File created"
}
ParâmetroDescrição
base64_binary_file (obrigatório)Arquivo que será enviado para os servidores da D4Sign. ATENÇÃO: Você deve enviar o binário do seu arquivo codificado em BASE64
mime_type (obrigatório)Informe o MIMETYPE do seu arquivo
name (opcional)Informe o nome do seu arquivo

UPLOAD de um hash de documento (HASH)

POST/documents/{UUID-SAFE}/uploadhash

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do hash de um documento para os servidores da D4Sign.

Após o UPLOAD, o hash de documento será criptografado em nossos cofres e carimbado com um número de série.

Todos os documentos ficam armazenados em COFRES criptografados, ou seja, o parâmetro UUID-SAFE é obrigatório e determina em qual cofre o hash de documento ficará armazenado.

{
    "sha256": "13f2a91a9e85d5240ff32754eba41c02...",
    "sha512": "9ddd2c2659ae6cd6790d1f31780c904145bd80272b51cb...",
    "name": "Meu contrato de venda",
    "uuid_folder": "{UUID DA PASTA}"
}
{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}
ParâmetroDescrição
sha256 (obrigatório)Informe o sha256 do arquivo em HEXADECIMAL. O sha256 deverá possuir 64 caracteres. Atenção: Não envie o sha256 em binário.
sha512 (obrigatório)Informe o sha256 do arquivo em HEXADECIMAL. O sha512 deverá possuir 64 caracteres. Atenção: Não envie o sha256 em binário.
name (opcional)Informe o nome do seu arquivo
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.

Destacar cláusulas

POST/documents/{UUID-DOCUMENT}/addhighlight

Testar endpoint 🧪

Esse objeto cadastrará as informações (texto) para serem destacadas para o signatário

{
    "Content-Type": "application/json"
}
{
    "key_signer": "NwYj=",
    "email": "[email protected]",
    "text": "Cláusula que será destacada"
}
{
    "success": 1,
    "email": "[email protected]",
    "key_signer": "ODkyMzI0",
    "text": "Cláusula que será destacada"
}
ParâmetroDescrição
key_signerChave do signatário
email (obrigatório)E-mail do signatário cadastrado
textCláusula que será destacada

Enviar documento para assinatura

POST/documents/{UUID-DOCUMENT}/sendtosigner

Testar endpoint 🧪

Esse objeto enviará o documento para assinatura, ou seja, o documento entrará na fase 'Aguardando assinaturas', onde, a partir dessa fase, os signatários poderão assinar os documentos.

{
    "Content-Type": "application/json"
}
{
    "message": "{mensagem_para_o_signatário}",
    "skip_email": "1",
    "workflow": "0",
    "tokenAPI": "{token-user}"
}
{
    "message": "File sent to successfully signing"
}
ParâmetroDescrição
message (opcional)Mensagem que será enviada para os signatários, caso o parâmetro skip_email esteja definido como 0
skip_email (obrigatório)Opções:
0 = Os signatários serão avisados por e-mail que precisam assinar um documento.
1 = O e-mail não será disparado.
ATENÇÃO: Nos casos em que o EMBED ou a ASSINATURA PRESENCIAL estiver sendo usado, ou seja, quando o signatário for efetuar a assinatura diretamente do seu website ou em seu Tablet, o parâmetro skip_email DEVERÁ ser definido como 1
workflow (obrigatório)Opções:
0 = Para não seguir o workflow.
1 = Para seguir o workflow.
Caso o parâmetro workflow seja definido como 1, o segundo signatário só receberá a mensagem de que há um documento aguardando sua assinatura DEPOIS que o primeiro signatário efetuar a assinatura, e assim sucessivamente.
Porém, caso seja definido como 0, todos os signatários poderão assinar o documento ao mesmo tempo.

Cancelar um documento

POST/documents/{UUID-DOCUMENT}/cancel

Testar endpoint 🧪


Esse objeto irá cancelar o documento.

{
    "Content-Type": "application/json",
    "tokenAPI": "{token-user}"
}
{
    "comment": "comentário sobre o cancelamento"
}
{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "teste.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Atendimento",
    "statusId": "6",
    "statusName": "Cancelado",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento"
}
ParâmetroDescrição
comment (opcional)Insira um comentário sobre o cancelamento.

DOWNLOAD de um documento

POST/documents/{UUID-DOCUMENT}/download

Testar endpoint 🧪

Esse objeto irá gerar uma URL final para download do documento.

{
    "Content-Type": "application/json"
}
{
    "type": "{type}",
    "language": "pt"
}
{
    "url": "https://secure.d4sign.com.br/CODIGO",
    "name": "teste.pdf"
}
ParâmetroDescrição
type (opcional)Para realizar o download do arquivo completo, escolha ZIP nesse atributo. Para realizar o download apenas do PDF, escolha PDF nesse atributo.
language (opcional)Para realizar o download do arquivo em inglês, escolha en nesse atributo. Para realizar o download do arquivo em português, escolha pt nesse atributo.

Reenviar link de assinatura

POST/documents/{UUID-DOCUMENT}/resend

Testar endpoint 🧪

Esse objeto irá reenviar o link de assinatura para o signatário.

{
    "Content-Type": "application/json"
}
{
    "email": "[email protected]" ou "551987651213",
    "key_signer": "NwUj="
}
{
    "message": "Message sent"
}
ParâmetroDescrição
email ou WhatsApp (obrigatório)Email ou WhatsApp do signatário que deverá receber o link novamente.
key_signerChave do signatário

Listar templates

POST/templates

Testar endpoint 🧪

Esse objeto irá retornar todos os templates criados em sua conta.

{
    "Content-Type": "application/json"
}
{
    "id": "MzE=",
    "name": "Nome do template",
    "variables": 
        array {
            "0": "variavel 1",
        "1": "variavel 2",
        "2": "variavel 3"
    }

}

Documento a partir do template HTML

POST/documents/{UUID-SAFE}/makedocumentbytemplate

Testar endpoint 🧪

Esse objeto irá gerar um documento em seu cofre a partir de um template.

{
    "Content-Type": "application/json"
}
{
    "name_document": "Nome do documento",
    "uuid_folder (opcional)": "{UUID DA PASTA}",
    "templates": {
        "id_template 1": {
            "variavel 1": "valor 1",
            "variavel 2": "valor 2",
            {...}
        },
        "id_template 2": {
            "variavel 1": "valor 1",
            "variavel 2": "valor 2",
            {...}
        },
   }
}
{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}

Exemplo id_template:


"MzE=" => array (
            'NOME_CLIENTE' => 'João',
            'CPF' => '222222222-22'),
"Mg==" => array (
            'NOME_CONTRATANTE' => 'fulano',
            'CNPJ' => '22332323233-02')
{...}
ParâmetroDescrição
name_document (opcional)Define o nome do documento. Se não for preenchido, o documento terá o nome "Documento"
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.
id_template (obrigatório)Array contendo o ID do template na CHAVE e as variáveis no VALUE.
Você poderá concatenar vários templates, conforme o exemplo acima. Lembrando que você deverá informar pelo menos um template. As variavéis dos campos personalizados (ex.: arrastando, bloco, NOME_CONTRATANTE, etc.) precisam ser informadas exatamente iguais ao cadastro.Ex.: 'NOME_CONTRATANTE' => 'fulano' irá substituir o campo personalizado NOME_CONTRATANTE por fulano. O sistema é case sensitive, ou seja, você deverá respeitar letras maiusculas e minusculas.

Documento a partir do template WORD

POST/documents/{UUID-SAFE}/makedocumentbytemplateword

Testar endpoint 🧪

Esse objeto irá gerar um documento em seu cofre a partir de um template word.

{
    "Content-Type": "application/json"
}
{
    "name_document": "Nome do documento",
    "uuid_folder (opcional)": "{UUID DA PASTA}",
    "templates": {
        "id_template 1": {
            "variavel 1": "valor 1",
            "variavel 2": "valor 2",
            {...}
        },
        "id_template 2": {
            "variavel 1": "valor 1",
            "variavel 2": "valor 2",
            {...}
        },
   }
}
{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}

Exemplo id_template:


"MzE=" => array (
            'NOME_CLIENTE' => 'João',
            'CPF' => '222222222-22'),
"Mg==" => array (
            'NOME_CONTRATANTE' => 'fulano',
            'CNPJ' => '22332323233-02')
{...}
ParâmetroDescrição
name_document (opcional)Define o nome do documento. Se não for preenchido, o documento terá o nome "Documento"
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.
id_template (obrigatório)Array contendo o ID do template na CHAVE e as variáveis no VALUE.
Você poderá concatenar vários templates, conforme o exemplo acima. Lembrando que você deverá informar pelo menos um template. As variavéis dos campos personalizados (ex.: arrastando, bloco, NOME_CONTRATANTE, etc.) precisam ser informadas exatamente iguais ao cadastro.Ex.: 'NOME_CONTRATANTE' => 'fulano' irá substituir o campo personalizado NOME_CONTRATANTE por fulano. O sistema é case sensitive, ou seja, você deverá respeitar letras maiusculas e minusculas.

Did this page help you?