Variantes del origen del documento
Última revisión: 30 Agosto 2021
A efectos de facilitar las pruebas, en todos los casos de uso descritos en los capítulos anteriores se ha utilizado la opción donde Viafirma es quien genera el PDF a partir de una plantilla previamente definida. El Documento que será enviado al firmante podrá ser construido de varias formas:
- Documento publicado en una URL.
- Documento previamente subido al sistema.
- Documento generado a partir de una plantilla.
- Documento previamente firmado en Viafirma.
El único cambio a tener en cuenta a la hora de definir el servicio afecta al objeto document
:
PDF previamente subido
Para subir un documento necesitamos pedir vía API un link al que subir el documento
GET https://{{endpoint}}/uploads/link/pdf
con la siguiente respuesta
{
"link": "https://{{endpoint}}",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1cGxvYWRFeHBpcmVzIjoiMTYyOTk3MjEzMjIyMiIsInVwbG9hZENvZGUiOiIxNjI5OTcyMTMyMjIyXzNkNzcxNzExLWIyN2UtNDljMi05MjgwLTdhODJkZWU0Yjg4Yy5wZGYifQ.1TKQxrKoXbgU7eE9-qdcpR24mnRAhA75p_fDErdZQZ4",
"expires": 1629972132222
}
Subimos el fichero con un PUT a la url indicada en el atributo link de la respuesta anterior
El integrador indica la referencia (atributo token de la respuesta anterior) al PDF subido anteriormente y que debe ser firmado:
"document" : {
"templateType" : "uploaded",
"templateReference" : "<here_your_token>",
"templateCode" : "your_template",
"readRequired" : true,
"watermarkText" : "Previsualización"
}
PDF publicado en URL
El integrador publica el PDF en una URL en la que Viafirma lo recuperará para su procesamiento:
"document" : {
"templateType" : "url",
"templateReference" : "<here_your_url",
"templateCode" : "your_template",
"readRequired" : true,
"watermarkText" : "Previsualización"
}
PDF basado en plantilla
El integrador indica el código de la plantilla que se usará para construir el documento. Esta plantilla debe existir previamente en Viafirma.
"document" : {
"templateType" : "pdf",
"templateCode" : "your_template",
"readRequired" : true,
"watermarkText" : "Previsualización"
}
PDF previamente firmado en Viafirma
El integrador hacer referencia a un proceso de firma de Viafirma, usando el PDF firmado en dicho proceso para volver a ser enviado y firmado.
"document" : {
"templateType" : "message",
"templateReference" : "<your_messageCode>",
"templateCode" : "your_template",
"readRequired" : true,
"watermarkText" : "Previsualización"
}
En la colección postman que puedes descargar para probar el API de viafirma tienes un set de pruebas con estas modalidades llamado "Variantes del origen del PDF".
results matching ""
No results matching ""