Referência: situações e eventos

Tabelas de consulta rápida com todos os valores que a API devolve ou aceita.

Situações do envelope#

Situação	Significado	Final
`rascunho`	Criado, ainda não enviado (ou aguardando o PDF do modelo)	Não
`enviado`	Enviado; ninguém assinou ainda	Não
`em_andamento`	Ao menos uma assinatura registrada	Não
`concluido`	Todos assinaram; via final disponível	Sim
`recusado`	Um signatário recusou	Sim
`expirado`	O prazo venceu sem todas as assinaturas	Sim
`cancelado`	Cancelado pelo remetente	Sim

Situações do signatário#

Situação	Significado
`pendente`	Aguardando a vez ou o envio
`notificado`	Convite entregue
`visualizado`	Abriu o documento
`assinado`	Assinou
`recusado`	Recusou

Valores aceitos na criação#

Campo	Valores	Padrão
`ordem`	`paralela`, `sequencial`	`paralela`
`nivel`	`avancada`, `simples`	`avancada`
`idioma`	`pt`, `en`, `es`	Idioma da conta
`papel`	`signatario`, `testemunha`, `aprovador`, `observador`	`signatario`
`canal_otp`	`email`, `conversa`	`conversa` em contas vindas do ChatISP; nas demais, o canal configurado na conta (de início `email`)
`origem` (resposta)	`painel`, `api`, `chatisp`	Definido pelo Ravisign

Em breve nível qualificada (com certificado ICP-Brasil do signatário) e código de confirmação por SMS e por WhatsApp pela API oficial.

Limites#

Item	Limite
Tamanho do PDF	20 MB (cerca de 27 MB em base64)
Signatários por envelope	1 a 50, com ao menos um que não seja observador
Título	190 caracteres
Mensagem do convite	2000 caracteres
Motivo de cancelamento	500 caracteres
Valor de variável de modelo	5000 caracteres
`referencia_externa`	190 caracteres
Prazo (`expira_em`)	De 1 hora a 365 dias a partir de agora
Prazo (`prazo_dias`)	1 a 365 dias
Lembrete automático	0 a 720 horas (0 desliga)
Código de confirmação	6 dígitos; 10 minutos por e-mail, 30 minutos na conversa; 5 tentativas; até 4 por hora
Paginação	`limite` de 1 a 100, padrão 50
Cota da chave	Padrão 60 requisições por minuto, até 600
Webhooks por conta	10
Tentativas de entrega de webhook	8

Eventos de webhook#

Evento	Quando	`dados`
`envelope.enviado`	O envelope foi enviado aos signatários	`{}`
`signatario.visualizou`	O signatário abriu o documento	`signatario`
`signatario.assinou`	O signatário assinou	`signatario`
`signatario.recusou`	O signatário recusou (o envelope fica `recusado`)	`signatario`
`envelope.concluido`	Todos assinaram e a via final está pronta	`hash_final`
`envelope.expirado`	O prazo venceu sem todas as assinaturas	`{}`
`envelope.cancelado`	O envelope foi cancelado	`{}`
`signatario.otp_solicitado`	No canal conversa, o signatário pediu um código novo na página	`signatario`, `codigo`, `validade_minutos`, `expira_em`
`webhook.teste`	Teste disparado por `webhooks/testar`	`mensagem`

Eventos da trilha de auditoria#

Devolvidos por envelopes/eventos. O significado de cada um está em Trilha de auditoria.

envelope_criado, envelope_enviado, notificacao_enviada, link_aberto, documento_visualizado, otp_enviado, otp_validado, otp_falhou, assinado, recusado, lembrete_enviado, expirado, cancelado, documento_final_gerado, concluido, webhook_entregue, ancoragem, conclusao_retomada.

Cabeçalhos#

Cabeçalho	Onde	Conteúdo
`Authorization`	Requisição	`Bearer rsg_...`
`X-Ravisign-Api-Versao`	Toda resposta	`1`
`X-RateLimit-Limite`	Resposta	Requisições permitidas por minuto
`X-RateLimit-Restante`	Resposta	Quantas ainda cabem no minuto
`X-RateLimit-Reinicio`	Resposta	Segundos até a contagem zerar
`Retry-After`	Resposta 429	Segundos de espera antes de repetir
`X-Ravisign-Evento`	Entrega de webhook	O evento
`X-Ravisign-Entrega`	Entrega de webhook	Identificador da entrega, igual em todas as tentativas
`X-Ravisign-Tentativa`	Entrega de webhook	Número da tentativa (1 a 8)
`X-Ravisign-Assinatura`	Entrega de webhook	`sha256=` e o HMAC-SHA256 do corpo

Ações da API#

Ação	Método	Escopo
`conta/situacao`	GET	`conta.ler`
`modelos/listar`	GET	`modelos.ler`
`modelos/detalhe`	GET	`modelos.ler`
`envelopes/criar`	POST	`envelopes.escrever`
`envelopes/enviar`	POST	`envelopes.escrever`
`envelopes/detalhe`	GET	`envelopes.ler`
`envelopes/listar`	GET	`envelopes.ler`
`envelopes/eventos`	GET	`envelopes.ler`
`envelopes/lembrar`	POST	`envelopes.escrever`
`envelopes/cancelar`	POST	`envelopes.escrever`
`documentos/baixar`	GET	`documentos.ler`
`signatarios/link`	GET	`envelopes.escrever`
`signatarios/otp_gerar`	POST	`envelopes.escrever`
`signatarios/otp_pendente`	GET	`envelopes.escrever`
`webhooks/criar`	POST	`envelopes.escrever`
`webhooks/listar`	GET	`envelopes.ler`
`webhooks/testar`	POST	`envelopes.escrever`
`webhooks/remover`	POST	`envelopes.escrever`

Não encontrou o que procurava?

Fale com o suporte da Ravi Systems pelo e-mail abaixo.

contato@ravisystems.com.br