Pular para as operações

Compliance

Clicksign em um fluxo de decisão.

6 Clicksign operations a decision flow can call directly, with the credentials your own contract issued. The response is data the rest of the flow reads, branches on, and keeps in the trace.

Categoria
Compliance
Tipo
Integração
Autenticação
Chave de API
Ambiente de teste
Host de sandbox separado

Quem são

Plataforma brasileira de assinatura eletrônica para documentos em setores regulados.

A Clicksign coleta assinaturas eletrônicas com validade jurídica e guarda a evidência que cada uma exige: método de autenticação, carimbos de tempo e o próprio documento assinado. É a incumbente do mercado brasileiro e é usada onde o contrato precisa sobreviver a uma contestação, o que descreve quase todo crédito e seguro. A API mais nova modela um envelope com vários documentos e signatários, e não um arquivo só.

O que um fluxo pode chamar

6 operações, cada uma um passo que você coloca no editor.

  1. POST/envelopes

    Criar um envelope

    Abre um envelope em rascunho. Nada é enviado ainda — documentos e signatários são adicionados a ele, e só a chamada de ativação pede que alguém assine.

  2. POST/envelopes/$data.clicksign_envelope_id/signers

    Adicionar um signatário

    Adiciona uma parte ao envelope. Todo signatário precisa de pelo menos um requisito de autenticação antes de o envelope poder ser ativado, então um signatário adicionado sem um trava a ativação em vez de falhar aqui.

  3. PATCH/envelopes/$data.clicksign_envelope_id

    Enviar para assinatura

    Tira o envelope do rascunho e o coloca em andamento, que é o que de fato avisa os signatários.

  4. GET/envelopes/$data.clicksign_envelope_id

    Conferir se já foi assinado

    The envelope's current state. This is the read a flow does when it resumes: running means someone still has to sign, closed means it finished, and cancelled means it will not.

  5. GET/envelopes/$data.clicksign_envelope_id/documents

    Listar os documentos de um envelope

    Os documentos que o envelope contém e o estado de cada um.

  6. GET/envelopes

    Listar envelopes

    Lista envelopes com os filtros usuais de JSON:API.

Onde isso entra na decisão

Compliance calls have a natural place in a flow.

A triagem responde às partes da decisão sobre as quais um regulador vai perguntar, então o que importa não é só o veredito, mas o registro dele. A correspondência parcial é o caso interessante: raramente uma recusa por si só, e normalmente o ponto em que o fluxo abre um caso para um revisor com a evidência anexada.

Whatever Clicksign returns is part of the run, so it is part of the record. When someone asks months later why an applicant was declined, the answer cites what came back at the time rather than re-fetching from a service whose answer has since changed.

  • 01Add Clicksign as a connection authenticating with an API key.
  • 02A Clicksign mantém um host de sandbox separado, então um fluxo no Sandbox consegue fazer a chamada real sem tocar em produção.
  • 03Coloque um nó de Conexão e escolha uma operação — “Criar um envelope” costuma ser a primeira de que um fluxo precisa.
  • 04Mapeie a resposta nos campos que suas regras leem e depois teste o caminho inteiro antes de ele receber tráfego de produção.

Perguntas frequentes

Usando a Clicksign em um fluxo.

Como conecto a Clicksign a um fluxo de decisão?

Adicione a Clicksign como uma conexão no seu workspace, autenticando com uma chave de API, com as credenciais que o seu próprio contrato emitiu — a ArboRule chama o provedor no seu lugar e nunca assume um contrato por você. Depois que a conexão existe, qualquer fluxo do workspace pode colocar um nó de Conexão e escolher uma das operações dela. As credenciais ficam na conexão, não no fluxo, então quem cuida da política usa a Clicksign em uma decisão sem nunca ver o segredo.

Dá para testar a Clicksign sem tocar em produção?

Dá. A Clicksign mantém um host de sandbox separado, então um fluxo rodando no Sandbox faz a chamada real com credenciais de teste e você lê o formato verdadeiro da resposta na trilha antes de qualquer coisa chegar a um cliente. O fluxo não muda quando é promovido — muda só quais credenciais respondem.

O que um fluxo pode chamar na Clicksign?

6 operações, incluindo “Criar um envelope”, “Adicionar um signatário”, “Enviar para assinatura”. Cada uma é um passo que você coloca no editor e mapeia nos campos que suas regras leem, e a maioria dos fluxos começa por “Criar um envelope”. A lista vem do mesmo manifesto que o motor usa para fazer a chamada, então esta página não consegue descrever uma operação que o produto não tem.

Em que ponto de uma decisão a Clicksign deve ser chamada?

A triagem responde às partes da decisão sobre as quais um regulador vai perguntar, então o que importa não é só o veredito, mas o registro dele. A correspondência parcial é o caso interessante: raramente uma recusa por si só, e normalmente o ponto em que o fluxo abre um caso para um revisor com a evidência anexada.

Quando você quiser

Wire Clicksign into a real decision.

Monte o fluxo no Sandbox, conecte sua conta e veja a decisão buscar o que precisa antes de responder.

Leia a documentação