Assinatura via API
Requisição para a assinar documentos via API na Clicksign. Esta é uma requisição
POST
para/api/v1/sign
. No body, deverão ser enviados os atributos da assinatura.
AtençãoO objetivo desta requisição é possibilitar que assinaturas recorrentes, como as realizadas por diretores ou procuradores de empresas, sejam automatizadas através da API. Para tanto, é necessário autorização prévia do signatário para a realização da mesma através da assinatura do Termo de Autorização.
Passo a passo
- Crie um signatário com o campo
auths=["api"]
. Veja documentação em Criar signatário. - Preencha um dos formulários disponíveis abaixo, dependendo do ambiente no qual seu signatário tenha sido criado:
- Para o Ambiente de Produção, a Clicksign enviará para assinatura do Operador e do Signatário o Termo de Autorização.
- A Clicksign enviará o Segredo (secret) do Signer para o e-mail do Operador de forma criptografada em até 1 dia útil.
- Utilize o secret para calcular o parâmetro
secret_hmac_sha256
que deverá ser enviado nesta requisição. Confira na tabela abaixo.
Requisição
POST /api/v1/sign?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
Atributos para assinatura do documento
Atributo | Descrição | Exemplo |
---|---|---|
| Chave disponível no JSON de Adicionar signatário ao documento. | 3487ca99-0e37-9754-a9f7-6375c7ea6a0d |
| Calcule o HMAC SHA256 da soma do Atenção: não formate o Validador online de HMAC
| fffde3b71e5c2... |
Se a requisição para a Clicksign falharSempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.
Exemplo completo
Request
POST /api/v1/sign?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
{
"request_signature_key": "870086c3-2831-7f2f-0ca3-98196cfb8428",
"secret_hmac_sha256": "fffde3b71e5c252cd00cf26e4957cb58faa8ae6e2c804bbbf3de4ffda3588115"
}
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Updated 3 months ago