Workflow
Criação e manipulação do workflow
Na criação de um workflow é definido todos os passos que serão realizados durante a aprovação/assinatura de um documento ou mais documentos.
O workflow seguirá respectivamente a sequência de envio dos steps definidos na chave “workflowSteps”.
post
https://api-v1.assine.online
/v1/workflow
Criar um workflow
Os campos whatsappNumber e notifyWhatsapp dentro de files[].workflowSteps[].user somente são necessários se você tiver o recurso de envio por Whatsapp habilitado. Caso queira contratar, procure o time comercial.
get
https://api-v1.assine.online
/v1/workflow/:id
Buscar um workflow
Possíveis status do workflow:
0: Rascunho, ou seja, ainda não iniciou-se.1: Circulando, ou seja, o fluxo se iniciou e está aguardando que as pessoas assinem.2: Cancelado, ou seja, a pessoa que criou o fluxo cancelou.3: Expirado, ou seja, o fluxo passou da data de vencimento definida.4: Processando, ou seja, o documento está sendo processado com o cálculo de criptografia da assinatura.5: Rejeitado, ou seja, algum dos assinantes rejeitou assinar este workflow.6: Completado, ou seja, todos os assinantes efetuaram a assinatura e o documento está totalmente assinado.
Possíveis status do step do workflow, ou seja, status do assinante se foi aprovado ou não (Propriedade:
_embedded.documents[].workflowSteps[].status):0: Não iniciado, ou seja, o fluxo ainda não se iniciou e a pessoa ainda não recebeu o email pedindo a assinatura.1: Aguardando assinatura, ou seja, aguardando que o assinante peça para assinar.2: Na fila de processamento, ou seja, está na fila para processar a assinatura.3: Processando, ou seja, está no processo de gerar as chaves e cálculos para realizar a assinatura.4: Aprovado, ou seja, já foi processado e o usuário aprovou que o documento possa ser assinado, podendo avançar para o próximo passo que no nosso caso, o próximo passo é pedir a assinatura de Maria.5: Rejeitado, ou seja, o assinante rejeitou assinar o documento, abortando todo o fluxo.
É possível encontrar os links temporários para download do documento em sua versão original na chave “originalFile” e sua versão assinada/preenchida atual em “file”.
get
https://api-v1.assine.online
/v1/workflow
Listar workflows
patch
https://api-v1.assine.online
/v1/workflow/:id
Iniciar um workflow
O corpo da requisição é literalmente:
{
"status": 1
}
patch
https://api-v1.assine.online
/v1/workflow/:id
Cancelar workflow
O corpo da requisição é literalmente:
{
"status": 2
}
Last modified 9mo ago