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
| Ambiente | Endereço | Validade jurídica |
|---|---|---|
| Produção | https://secure.d4sign.com.br/criar.html | Sim |
| Desenvolvimento (SandBox) | https://sandbox.d4sign.com.br/criar.html | Não |
Passos básicos para iniciar
- Realizar o upload do documento
- Cadastrar o webhook(POSTBack) //OPCIONAL
- Cadastrar os signatários
- Enviar o documento para assinatura
- Utilizar o EMBED D4Sign para exibir o documento em seu website //OPCIONAL
Erros de requisições
| JSON |
|---|
| 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 10 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]
Aumente o número de requisições por hora da sua API. Fale com o [email protected]
Testando com o Postman
https://app.getpostman.com/run-collection/5d43ba6b3834eb9f5c66
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).
Updated 8 months ago