Utilizando Envelopes na API Clicksign

Bem-vindo à documentação da API Clicksign! Esta versão da documentação apresenta o uso de envelopes via API. Envelopes são uma forma de agrupar documentos e signatários em uma única entidade, facilitando o gerenciamento e a assinatura de documentos.

Se você preferir consultar a versão anterior da documentação de API, que não inclui o uso de envelopes, clique aqui.

Para quaisquer dúvidas ou sugestões, não hesite em entrar em contato conosco em [email protected].

Ativação do Envelope na conta

O envelope está ativo para contas criadas a partir de 01/07/2024. Caso receba o erro de serviço indisponível, entre em contato com [email protected] .

Obtendo Acesso à API:

1. Crie uma conta no ambiente Sandbox

Para começar, você precisa criar uma conta no ambiente Sandbox. Entre em https://sandbox.clicksign.com/signup e crie uma conta.

2. Gere um Access Token

Uma vez que você tenha criado sua conta, vá para as configurações, em seguida, acesse a aba API e gere um Access Token.

3. Associe o usuário à API

Para liberar a utilização do Access Token para a conta, é necessário associar o usuário para a utilização da API.

4. Faça um teste de autenticação

Com base no Access Token gerado, é possível testar seu acesso pelo navegador, basta acessar o endereço https://sandbox.clicksign.com/api/v3/envelopes?access_token={{access_token}} substituindo {{access_token}} pelo seu Access Token.

Exemplos de resposta:

{
  "data": [],
  "meta": {
    "record_count": 0
  },
  "links": {
    "first": "https://sandbox.clicksign.com/api/v3/envelopes?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://sandbox.clicksign.com/api/v3/envelopes?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

Utilização do Envelope na Clicksign API

O Envelope na Clicksign é um recurso essencial que facilita o agrupamento de documentos e signatários em uma única entidade, simplificando o gerenciamento e a assinatura de documentos.

Componentes Básicos do Envelope:

Criar Envelope: Solicita a criação de um novo Envelope.
Adicionar Documento: Inclui um novo documento no Envelope previamente criado.
Adicionar Signatário: Integra um novo signatário para assinar um documento.
Adicionar Requisito de Qualificação: Define uma condição para a autenticação do signatário.
Adicionar Requisito de Autenticação: Estabelece uma condição para a qualificação da assinatura do signatário.
Ativar ou Alterar Configurações do Envelope: A Ativação do Envelope se dá com a alteração do status de draft para running.

Notificação para Assinatura

Disparar Notificação de Signatário: Envia uma notificação ao signatário para assinar o documento.
Disparar Notificação de Envelope: Notifica todos os signatários associados ao Envelope para assinatura.

Outras Operações

Consultar Eventos: Consulta eventos de todos documentos relacionados ao envelope.
Cancelar ou Finalizar um Documento: O cancelamento ou finalização de um documento se dá com a alteração do status para canceled ou closed.

Na Prática

Desenvolvemos um guia passo a passo para realizar requisições utilizando cURL como demonstração:

Criação e Configuração do Envelope

Open Recipe

Formato JSON da API com Envelope

A API da Clicksign utiliza o padrão JSON API para formatação de requisições e respostas. No contexto do Envelope, é essencial seguir essas especificações. Para isso, é necessário configurar os cabeçalhos HTTP da seguinte forma:

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

GET /api/v3/envelopes HTTP/2
Host: sandbox.clicksign.com
Authorization: {{access_token}}
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

curl --request GET \
  --url 'https://sandbox.clicksign.com/api/v3/envelopes' \
  --header 'Authorization: {{access_token}}' \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'accept: application/vnd.api+json'

Conte com a nossa ajuda!

Estamos comprometidos em fornecer a você todas as ferramentas necessárias para simplificar e aprimorar seus processos de assinatura eletrônica. Não hesite em nos contatar se tiver alguma dúvida ou precisar de assistência adicional. Estamos sempre disponíveis através do e-mail [email protected].