Documentos y plantillas

Esta página reúne las acciones que trabajan con archivos: listar y detallar las plantillas de la cuenta (para crear sobres a partir de ellas) y descargar el original o la copia final firmada de un sobre. Como las plantillas se crean y versionan en el panel, consulte Plantillas.

En los ejemplos, la clave está en la variable de entorno RAVISIGN_CHAVE y las respuestas se acortaron donde se indica:

export RAVISIGN_CHAVE="rsg_..."
API="https://ravisign.com.br/api/v1"

modelos/listar#

GET, alcance modelos.ler. Plantillas de documento de la cuenta (sin el contenido). tipo es html (texto con variables {{chave}}, completadas al crear el sobre) o pdf (PDF fijo, sin variables). Parámetros opcionales: busca (en el nombre o en la descripción), ativo (true de forma predeterminada, false o todos), pagina, limite.

curl -sS -G "$API/modelos/listar" -H "Authorization: Bearer $RAVISIGN_CHAVE" -d limite=20

{
    "ok": true,
    "modelos": [
        {
            "id": 1,
            "nome": "Contrato de adesão",
            "descricao": "",
            "tipo": "html",
            "variaveis": [
                { "chave": "cliente", "rotulo": "Nome do cliente", "obrigatoria": true },
                { "chave": "plano", "rotulo": "Plano", "obrigatoria": false }
            ],
            "versao": 1,
            "ativo": true,
            "criado_em": "2026-10-09T20:28:25-03:00",
            "atualizado_em": "2026-10-09T20:28:25-03:00"
        }
    ],
    "paginacao": { "pagina": 1, "limite": 20, "total": 1, "paginas": 1 }
}

modelos/detalhe#

GET, alcance modelos.ler. Parámetro id. Mismo formato que el elemento de la lista, más el contenido html (en las plantillas del tipo html).

curl -sS -G "$API/modelos/detalhe" -H "Authorization: Bearer $RAVISIGN_CHAVE" -d id=1

{
    "ok": true,
    "modelo": {
        "id": 1,
        "nome": "Contrato de adesão",
        "tipo": "html",
        "variaveis": [ { "chave": "cliente", "rotulo": "Nome do cliente", "obrigatoria": true } ],
        "versao": 1,
        "ativo": true,
        "html": "<p>Cliente: {{cliente}} | Plano: {{plano}}</p>"
    }
}

(respuesta acortada)

documentos/baixar#

GET, alcance documentos.ler. Parámetros envelope_uuid y tipo: final (predeterminado: la copia firmada, con el manifiesto de firmas incorporado) u original (el PDF tal como se envió). La respuesta de éxito es el propio PDF (Content-Type: application/pdf, Content-Disposition: attachment con el nombre del archivo); los errores siguen en JSON.

curl -sS -G "$API/documentos/baixar" -H "Authorization: Bearer $RAVISIGN_CHAVE" \
  -d envelope_uuid=157b650a-75e0-4eaa-a32c-b92b5a432ee4 -d tipo=final \
  -o "contrato-assinado.pdf" -w "%{http_code}\n"

200

Nombre del archivo: el nombre del documento (documento.nome, que viene del título o, en la carga, del nombre del archivo enviado), con - assinado antes del .pdf en la copia final ("signed" y "firmado" en cuentas en inglés y español). Errores: 409 arquivo_indisponivel (copia final antes de la conclusión), 409 documento_pendente (original de plantilla todavía en preparación), 400 parametro_invalido en el campo tipo. El manifiesto de firmas va dentro de la copia final, por eso documento.disponivel.manifesto viene false y tipo=manifesto responde 409 arquivo_indisponivel. Para verificar la integridad, compare el SHA-256 del archivo descargado con hash_final o hash_original de detalhe.

Crear un sobre a partir de una plantilla#

Use modelo_id y variaveis en envelopes/criar. Las claves de variaveis son las mismas que devuelve modelos/detalhe. El ejemplo completo está en Sobres en la API.

Nota la gestión de plantillas por la API (crear y editar) está reservada para una versión futura, con el alcance modelos.escrever. Hoy las plantillas se crean en el panel.