Introdução a API

REST API D4Sign


Informações Gerais


A D4Sign é uma plataforma de assinatura eletrônica de documentos que atende os requisitos da Medida Provisória 2.200-2/01, ou seja, autenticidade, integridade e não repúdio. Trazendo, assim, validade jurídica para todas as assinaturas realizadas através da D4Sign.

Seja bem-vindo ao guia de referências da API da D4Sign! É através desta API que você irá integrar o seu sistema ao nosso. Você poderá utilizar todos os recursos da plataforma através dessa API, como, por exemplo, enviar documentos para assinatura e exibí-los em seu website, mantendo o usuário em seu ambiente.

Ambiente

Endpoint

Validade jurídica

Produção

https://secure.d4sign.com.br/api/v1

Sim

Desenvolvimento (SandBox)

https://sandbox.d4sign.com.br/api/v1

Não

🚧

Nossa API é RESTful e todas as respostas são em JSON.


Endereços para cadastro


AmbienteEndereçoValidade jurídica
Produçãohttps://secure.d4sign.com.br/criar.htmlSim
Desenvolvimento (SandBox)https://sandbox.d4sign.com.br/criar.htmlNão


Passos básicos para iniciar

  1. Realizar o upload do documento
  2. Cadastrar o webhook(POSTBack) //OPCIONAL
  3. Cadastrar os signatários
  4. Enviar o documento para assinatura
  5. Utilizar o EMBED D4Sign para exibir o documento em seu website //OPCIONAL

Erros de requisições

Resposta 4XX

Body: { "message": "Erro" }
Content-Type: application/json

O retorno de um erro 4xx indica que os parâmetros ou endpoint da sua requisição estão incorretos.

Resposta 5XX

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

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


Formatação JSON

A API da D4Sign utiliza JSON como formato das requisições. Todas as respostas serão em JSON.
Inclua, também, Accept: application/json e Content-Type: application/json no HEADER.


Autenticação

Realizamos a autenticação através dos parametros tokenAPI e cryptKey.

Você deve, sempre, incluir esses parametros em suas requisições. Ex.: ?tokenAPI={token_user}&cryptKey={crypt_key}

🚧

O parâmetro cryptKey só precisa ser enviado caso esteja habilitado em sua conta.


API Keys

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

Você terá um limite de 50 requisições por hora. Para aumentar esse limite, entre em contato com o [email protected]

👍

Em caso de dúvidas sobre onde encontrar a sua Chave de API, entre em contato pelo e-mail [email protected]


Testando com o Postman

Run in PostmanRun in Postman

Postman é um aplicativo com a função de testar e desenvolver APIs em uma interface bastante simples e intuitiva. Ele nos permite simular requisições HTTP de forma rápida, armazenando-as para que possamos usá-las posteriormente.

Para testar o uso da API D4Sign com o Postman, basta clicar no botão acima. Após a instalação e importação da biblioteca "D4Sign - API", você precisará configurar o tokenAPI e cryptKey no canto superior direito.

Se preferir, acesse a documentação do Postman:
https://documenter.getpostman.com/view/1486030/d4sign-api/2TnpL3

🚧

Atenção: O host padrão configurado no Postman é o host de Desenvolvimento (SandBox).


Did this page help you?