Tablas de consulta rápida con todos los valores que la API devuelve o acepta.
Estados del sobre#
| Estado |
Significado |
Final |
rascunho |
Creado, todavía no enviado (o esperando el PDF de la plantilla) |
No |
enviado |
Enviado; nadie firmó todavía |
No |
em_andamento |
Al menos una firma registrada |
No |
concluido |
Todos firmaron; copia final disponible |
Sí |
recusado |
Un firmante lo rechazó |
Sí |
expirado |
El plazo venció sin todas las firmas |
Sí |
cancelado |
Cancelado por el remitente |
Sí |
Estados del firmante#
| Estado |
Significado |
pendente |
Esperando su turno o el envío |
notificado |
Invitación entregada |
visualizado |
Abrió el documento |
assinado |
Firmó |
recusado |
Rechazó |
Valores aceptados en la creación#
| Campo |
Valores |
Valor predeterminado |
ordem |
paralela, sequencial |
paralela |
nivel |
avancada, simples |
avancada |
idioma |
pt, en, es |
Idioma de la cuenta |
papel |
signatario, testemunha, aprovador, observador |
signatario |
canal_otp |
email, conversa |
conversa en cuentas provenientes de ChatISP; en las demás, el canal configurado en la cuenta (inicialmente email) |
origem (respuesta) |
painel, api, chatisp |
Definido por Ravisign |
Próximamente nivel qualificada (con certificado ICP-Brasil del firmante) y código de confirmación por SMS y por WhatsApp mediante la API oficial.
Límites#
| Elemento |
Límite |
| Tamaño del PDF |
20 MB (cerca de 27 MB en base64) |
| Firmantes por sobre |
1 a 50, con al menos uno que no sea observador |
| Título |
190 caracteres |
| Mensaje de la invitación |
2000 caracteres |
| Motivo de cancelación |
500 caracteres |
| Valor de variable de plantilla |
5000 caracteres |
referencia_externa |
190 caracteres |
Plazo (expira_em) |
De 1 hora a 365 días a partir de ahora |
Plazo (prazo_dias) |
1 a 365 días |
| Recordatorio automático |
0 a 720 horas (0 lo desactiva) |
| Código de confirmación |
6 dígitos; 10 minutos por correo electrónico, 30 minutos en la conversación; 5 intentos; hasta 4 por hora |
| Paginación |
limite de 1 a 100, 50 de forma predeterminada |
| Cuota de la clave |
60 solicitudes por minuto de forma predeterminada, hasta 600 |
| Webhooks por cuenta |
10 |
| Intentos de entrega de webhook |
8 |
Eventos de webhook#
| Evento |
Cuándo |
dados |
envelope.enviado |
El sobre fue enviado a los firmantes |
{} |
signatario.visualizou |
El firmante abrió el documento |
signatario |
signatario.assinou |
El firmante firmó |
signatario |
signatario.recusou |
El firmante rechazó (el sobre queda recusado) |
signatario |
envelope.concluido |
Todos firmaron y la copia final está lista |
hash_final |
envelope.expirado |
El plazo venció sin todas las firmas |
{} |
envelope.cancelado |
El sobre fue cancelado |
{} |
signatario.otp_solicitado |
En el canal de conversación, el firmante pidió un código nuevo en la página |
signatario, codigo, validade_minutos, expira_em |
webhook.teste |
Prueba disparada por webhooks/testar |
mensagem |
Eventos del registro de auditoría#
Devueltos por envelopes/eventos. El significado de cada uno está en Registro de auditoría.
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.
Encabezados#
| Encabezado |
Dónde |
Contenido |
Authorization |
Solicitud |
Bearer rsg_... |
X-Ravisign-Api-Versao |
Toda respuesta |
1 |
X-RateLimit-Limite |
Respuesta |
Solicitudes permitidas por minuto |
X-RateLimit-Restante |
Respuesta |
Cuántas caben todavía en el minuto |
X-RateLimit-Reinicio |
Respuesta |
Segundos hasta que el conteo vuelva a cero |
Retry-After |
Respuesta 429 |
Segundos de espera antes de repetir |
X-Ravisign-Evento |
Entrega de webhook |
El evento |
X-Ravisign-Entrega |
Entrega de webhook |
Identificador de la entrega, igual en todos los intentos |
X-Ravisign-Tentativa |
Entrega de webhook |
Número del intento (1 a 8) |
X-Ravisign-Assinatura |
Entrega de webhook |
sha256= y el HMAC-SHA256 del cuerpo |
Acciones de la API#
| Acción |
Método |
Alcance |
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 |