Introdução à API D4Sign (Leia antes de começar)

Informações Gerais

Nossa API é RESTful e todas as respostas são em JSON, facilitando a comunicação e o processamento dos dados.

Endereços para Cadastro: Para criar uma conta nos respectivos ambientes:

Passos Básicos para Iniciar

Para começar a utilizar a API D4Sign, siga estes passos fundamentais:

1. Realizar o upload do documento: Envie seus documentos para a plataforma D4Sign.

2. Cadastrar o webhook (POSTBack): (OPCIONAL) Configure uma URL para receber notificações sobre o status do documento.

3. Cadastrar os signatários: Informe quem deverá assinar o documento.

4. Enviar o documento para assinatura: Inicie o processo de coleta de assinaturas.

5. Utilizar o EMBED D4Sign para exibir o documento em seu website: (OPCIONAL) Integre a interface de assinatura diretamente na sua aplicação.

Erros de Requisições

Em caso de erros nas requisições, a API retornará uma resposta em JSON com a mensagem de erro. Por exemplo:

JSON 

Body: { "message": "Server error." }
Content-Type: application/json

Um retorno de erro 5xx indica que houve algum problema em nossos servidores.

Formatação JSON

A API da D4Sign utiliza JSON como formato padrão para as requisições e todas as respostas. É importante incluir os seguintes cabeçalhos (HEADER) em suas requisições:

Accept: application/json
Content-Type: application/json

Autenticação

A autenticação em nossas requisições é feita através dos parâmetros tokenAPI e cryptKey. Você deve sempre incluí-los em suas requisições.

• Exemplo: ?tokenAPI={token_user}&cryptKey={crypt_key}

🚧 Atenção: O parâmetro cryptKey só precisa ser enviado caso esteja habilitado em sua conta.

API Keys

Sua Chave de API está disponível em sua conta D4Sign. Faça login na plataforma e acesse o menu 'Dev API'.

Por padrão, você terá um limite de 10 requisições por hora. Para aumentar esse limite e adequá-lo às suas necessidades, entre em contato com o comercial@d4sign.com.br.

👍 Em caso de dúvidas sobre onde encontrar a sua Chave de API, entre em contato pelo e-mail suporte@d4sign.com.br. ❗️ Aumente o número de requisições por hora da sua API. Fale com o comercial@d4sign.com.br.

Testando com o Postman

Recomendamos o uso do Postman para testar e desenvolver suas integrações com a API D4Sign. É um aplicativo intuitivo que permite simular requisições HTTP e armazená-las para uso posterior.

Para testar o uso da API D4Sign com o Postman, basta clicar no botão abaixo para importar nossa coleção:

Após a instalação e importação da biblioteca "D4Sign - API", você precisará configurar o tokenAPI e a cryptKey no ambiente do Postman (geralmente no canto superior direito).

Se preferir, acesse a documentação pública do Postman da nossa API para referência detalhada: https://documenter.getpostman.com/view/1486030/d4sign-api/2TnpL3

🚧 Atenção: O host padrão configurado na coleção do Postman é o host de Desenvolvimento (SandBox). Lembre-se de alterá-lo para o ambiente de Produção quando estiver pronto para operações reais.