¶ 1. Introducción
Este documento contiene la documentación de los mecanismos para que aplicaciones desarrolladas por las instituciones puedan realizar procesos de firma de documentos utilizando las firmas electrónicas avanzadas de autoridades o funcionarios custodiadas en el Repositorio Centralizado de Firmas.
En este documento es posible encontrar datos genéricos para que puedan realizar la firma de documentos en ambiente de pruebas.
¶ 1.1 Diagrama de secuencia
A continuación se presenta el diagrama correspondiente a las acciones a realizar con el objetivo de obtener uno o más documentos firmados.
- Cliente: Aplicación cliente que requiere firmar uno o más documentos.
- API Firma: Interfaz entre las aplicaciones externas (clientes) y las operaciones asociadas a la firma de uno o más documentos.
- RA (Autoridad de Registro): Contiene el registro de las aplicaciones externas habilitadas para realizar operaciones de firma. Las aplicaciones deben estar previamente registradas y cumplir con un conjunto de restricciones asociadas a la identificación del certificado de firma electrónica avanzada a utilizar (entidad, propósito y run del titular de la firma).
- Banco: Repositorio donde se custodian los certificados de firma electrónica avanzada habilitados para realizar operaciones de firma. El banco recibe los documentos a firmar y realiza la operación de firma, nunca un certificado será expuesto.
¶ 1.2 Firmar Documento
Con esta llamada, se puede firmar documentos Hash, utilizando un certificado de firma electrónica avanzada de propósito general (atendido) o desatendido, este formato permitirá contar con una mayor rapidez en la respuesta y un tráfico más liviano.
Además se cuenta con la alternativa de firmar documentos tipo PDF o XML.
Para utilizar su firma desatendida, previamente tendrá que haber solicitado su certificado por el “Sistema de Solicitud de Firma Electrónica” y habilitado la aplicación correspondiente.
Para la firma de documentos se deben tener las siguientes consideraciones
- El tamaño de la solicitud no puede exceder el tamaño máximo que son 5 MB.
- Los documentos firmados no son almacenados en la plataforma FirmaGob, por lo que la Institución que realiza la Integración de su sistema debe contar con su propio repositorio de documentos.
- El resultado que se obtiene de la firma de documentos no incluye un código de verificación o un link para la obtención del documento, esto debe ser incorporado por la Institución que realiza la Integración.
¶ Protocolo: HTTPS
URL: https://api.firma.digital.gob.cl/firma/v2/files/tickets', método = ['POST']
HTTP Headers
OTP: <Valor OTP> (Esta cabecera sólo es necesaria para la firma atendida, en caso de ser firma desatendida, no se debe enviar esta cabecera).
Validación de OTP
En caso de exceder el número de OTPs erróneos (5 intentos) se desplegará el error 429: “Ha excedido el número máximo de intentos de OTP. Intente más tarde”. Cuando esto ocurra se bloquearán sus solicitudes hasta que ingrese un OTP correcto.
HTTP Parámetros
| token |
Campo encriptado y firmado en JWT con una clave simétrica, esta clave es obtenida a partir del registro de la aplicación. El campo JWT encriptado en algoritmo HS256 y firmado con clave simétrica contiene los siguientes campos:
 |
| api_token_key | Campo no encriptado de tipo string que contiene el código único generado a partir del registro de la aplicación. |
| files |
Array no encriptado que contiene información de él o los documentos sobre los cuales se realizarán operaciones de firma. Cada objeto del array según el formato de archivo a firmar debe contener:  A continuación se describe el tipo de dato asociado al parámetro requerido:
|
A continuación se presentan ejemplos de los parámetros:
| token |
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbnRpdHkiOiJTdWJzZWNyZXRhcsOtYSBHZW5lcmFsIGRlIGxhIFByZXNpZGVuY2lhIiwicnVuIjoiMjIyMjIyMjIiLCJleHBpcmF0aW9uIjoiMjAyMS0xMS0xNVQxNzozMTowMCIsInB1cnBvc2UiOiJEZXNhdGVuZGlkbyJ9.EqcNFArqasx_hlZSYTO2Tnuqa36dMn_qnmk90XEyhTA" Algoritmo: HS256, Secreto: 27a216342c744f89b7b82fa290519ba0 { "entity": "Subsecretaría General de la Presidencia", "run": "22222222", "expiration": "2021-11-15T17:31:00", "purpose": "Desatendido" } |
| api_token_key | sandbox |
| files |
[ { "content-type": "application/pdf", "content": "archivo en base64", "description": "str", "checksum": "hash en sha256" } ] |
| token |
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbnRpdHkiOiJTdWJzZWNyZXRhcsOtYSBHZW5lcmFsIGRlIGxhIFByZXNpZGVuY2lhIiwicnVuIjoiMjIyMjIyMjIiLCJleHBpcmF0aW9uIjoiMjAyMS0xMS0xNVQxNzozMTowMCIsInB1cnBvc2UiOiJEZXNhdGVuZGlkbyJ9.EqcNFArqasx_hlZSYTO2Tnuqa36dMn_qnmk90XEyhTA" Algoritmo: HS256, Secreto: 27a216342c744f89b7b82fa290519ba0 { "entity": "Subsecretaría General de la Presidencia", "run": "22222222", "expiration": "2021-11-15T17:31:00", "purpose": "Desatendido" } |
| api_token_key | sandbox |
| files |
[ { "content-type": "application/pdf", "content": "archivo en base64", "description": "str", "checksum": "hash en sha256" } ] |
¶
¶ Ejemplo del JSON BODY para firmar un documento PDF
Ejemplo del JSON BODY para el caso de hash
- Para obtener el content a firmar, se deben parsear el PDF según las indicaciones:
- Al firmar un hash, se debe tener en consideración que se debe agregar el content de respuesta (mensaje firmado en formato p7s) al diccionario de firma del PDF. Para hacer esto se recomienda el uso de la librería iText de Java o C#
¶ Ejemplo del JSON BODY para el caso de XML
- El content será el base64 del XML a firmar
- Se puede agregar información del firmante con el parámetro “xmlObject”. Quedará en el tag Object dentro de la firma con id “CustomObject_XXX”
- Se puede agregar las referencias a firmar con el parámetro “references” tipo Lista
- La respuesta tendrá dentro del content un XML firmado encodeado en base64
¶ Ejemplo del JSON BODY para el caso de JSON
- El content será el base64 del json a firmar por ejemplo: eyJrZXkxIjogInZhbHVlMSIsImtleTIiOiAidmFsdWUyIn0=
- La respuesta tendrá dentro del content un JSON encodeado en base64
¶ Response Json Schema Body
El resultado de este llamado corresponde a un JSON que contiene los documentos firmados.
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Recepción de documentos firmados",
"type": "object",
"required": [
"session_token",
"files"
],
"additionalProperties": false,
"properties": {
"session_token": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"OTP_expired": {
"type": "boolean"
},
"files_recived": {
"type": "number"
},
"files_signed": {
"type": "number"
},
"signed_failed": {
"type": "number"
}
},
"required": [
"OTP_expired",
"files_received",
"files_signed",
"signed_failed"
]
},
"files": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"checksum_original",
"status"
],
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"PDF",
"JSON",
"XML"
]
},
"content": {
"type": "string"
},
"checksum_original": {
"type": "string"
},
"checksum": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
}
Un ejemplo de respuesta es la siguiente:
{
"files": [
{
"content": "{"jws": "eyJhbGciOiJSUzI1NiIsImN0eSI6Impzb24iLCJ0eXAiOiJKV1MiLCJ4NWMiOlsiLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tXG5NSUlFN2pDQ0E5YWdBd0lCQWdJSUtsa0hpMkVRaW1Zd0RRWUpLb1pJaHZjTkFRRUxCUUF3TFRFck1Da0dBMVVFQXd3aVFXMWlhV1Z1ZEdVZ1pHVWdRMlZ5ZEdsbWFXTmhZMm5EczI0Z1UyVm5VSEpsY3pBZUZ3MHlNVEV4TURVeE1qRTVNRFJhRncweU5ERXhNRFV4TWpFNU1EUmFNSUd4TVNrd0p3WUpLb1pJaHZjTkFRa0JGaHBrWlhOaGRHVnVaR2xrYjBCa1pYTmhkR1Z1Wkdsa2J5NWpiREVOTUFzR0ExVUVBd3dFYm5Wc2JERVRNQkVHQTFVRUJSTUtNakl5TWpJeU1qSXRNakVZTUJZR0ExVUVEQXdQUTJGeVoyOGdaR1VnY0hKMVpXSmhNVGt3TndZRFZRUUtEREJOYVc1cGMzUmxjbWx2SUZObFkzSmxkR0Z5dzYxaElFZGxibVZ5WVd3Z1pHVWdiR0VnVUhKbGMybGtaVzVqYVdFeEN6QUpCZ05WQkFZVEFrTk1NSUlCSWpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQXQ0bHZiUHZFNVphZksrVmNEZXFrQmhDN05yY2txK2NiVDdqcHdrWkZsekN6MENBSHRDUkRyUXo2ZWtwcVZYd3hVMVpDVExaVEcyYWFpZEdtekxyamw3bmI1RHlzUkdYVUdyMGdsZi9xWE5sQ1dUemg2VjlCd2hjS3BMREtadTNCNFo2SzdCQWpXWmdyUEp3LzNhTHJ1dlh4L2lZSTVQTm16YXNDQU5pVk96d2pJVzlUcTd5am9ObjR0a3NEbU1nVCtSdjI3SkhXUEhHZXg3alU5THlBQ2psYWhORGQ4MUdKSDh5anhmVVhMeDNXcFN5bHBKcXhwaTJoNENOa1B6bTZQNmhLUTNjeGcwV0QxY09SNmZIdXNKa0tEVlp3VStpdmdJODU5enlCam1Cd2NiT2NwOERZUlNFYkFhY1psd0J2RmJVZUt4bmZ2UmxzVW9kYTkyM2Jvd0lEQVFBQm80SUJpekNDQVljd1BBWUlLd1lCQlFVSEFRRUVNREF1TUN3R0NDc0dBUVVGQnpBQmhpQm9kSFJ3T2k4dlptbHliV0V1WkdsbmFYUmhiQzVuYjJJdVkyd3ZiMk56Y0RBZEJnTlZIUTRFRmdRVUlXaW0vOG1yK2RySXpOa3I2ZE9HZG80RFphb3dEQVlEVlIwVEFRSC9CQUl3QURBZkJnTlZIU01FR0RBV2dCUXVlQllTbEdlYTNQU2FQYVRjZytyNlByaUloREFxQmdOVkhSSUVJekFob0I4R0NDc0dBUVFCd1FFQ29CTVdFVkpWVkY5RFJWSlVTVVpKUTBGRFNVOU9NRW9HQTFVZElBUkRNRUV3UHdZR1lJRVloMmtETURVd013WUlLd1lCQlFVSEFnRVdKMmgwZEhCek9pOHZabWx5YldFdVpHbG5hWFJoYkM1bmIySXVZMnd2Wkc5amRXMWxiblJ2Y3pBd0JnTlZIUjhFS1RBbk1DV2dJNkFoaGg5b2RIUndPaTh2WTJWeWRDNW1aV1F1WjI5aUxtTnNMMk5sY25RdVkzSnNNQXNHQTFVZER3UUVBd0lGNERBZEJnTlZIU1VFRmpBVUJnZ3JCZ0VGQlFjREFnWUlLd1lCQlFVSEF3UXdJd1lEVlIwUkJCd3dHcUFZQmdnckJnRUVBY0VCQWFBTUZnb3lNakl5TWpJeU1pMHlNQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUUJiM2FpaVVQeEFRWHhFS1ZLbDRUb0xLTnN5T2tIRllyVllRZ3E5TlhEcG0yZUpyTzdOenRVNmMzajMvVUpHMU9sRndtelB4Sm5tV0pPcE5obm03RXNCM0p2VGg3MjFibGNXT01Dby8wWnFyczV0NHNIbkhhbHd2M0JpRHYvZThXdUZHVTVKUDFkQSsvUTJpYzBneXJ4UzVFWmtMTGg2UXo4YVVVNGdiK0tFQm03VFduOEpmVjVvemNiVk55bHd3aXVleHV3M2JFSVIwRTFyT2xQdk55aXVNakJjRjNOaTNQYm1RcGhoa3daM3lOQUxsbzRQQndJS3lTcktLRUQyUU5Jc1JYMm5xbVQ4a05yU0ZrTHoxZms0YUJOUEJ4eDM1TVA4SitCTXMySGY4UTFGWmIzNk5YK2lkYVNSK1g3N0VUQ3BwUmx3eXFUbmVvckVmbWFQTTN1WFxuLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLSIsIi0tLS0tQkVHSU4gQ0VSVElGSUNBVEUtLS0tLVxuTUlJRWlEQ0NBM0NnQXdJQkFnSUlhUUFzUWFSSFlsZ3dEUVlKS29aSWh2Y05BUUVMQlFBd1RERWNNQm9HQ1NxR1NJYjNEUUVKQVJZTlUwOU5SVUJGVFVGSlRDNURUREVzTUNvR0ExVUVBd3dqUlU1VVNVUkJSQ0JTVDA5VUlFRk5Ra2xGVGxSRklFTkZVbFJKUmtsRFFVTkpUMDR3SGhjTk1UZ3hNakUzTVRNME5qTTNXaGNOTWpneE1qQTNNVFUwTmpRNFdqQXRNU3N3S1FZRFZRUUREQ0pCYldKcFpXNTBaU0JrWlNCRFpYSjBhV1pwWTJGamFjT3piaUJUWldkUWNtVnpNSUlCSWpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQWpGbERPaE56eWV2U2J4Qy96MDBoaS9KRnkwb1d2Y1E1SEp4elI4dkp2Y3h6Tit2cWM3NjI2di9nSUVBVFZ0QnhqNGNBVHVNMWNrL2pTWU1nZ1NnbUptRUVsbUYybzNLeHpHRHR4eHY5eDBUTWlBYzhtVGdsN1JDU1M3WEZTS1lUaERPbTBVRGg0Q1RwMk1MY1NRb2g1VGxrUWtNbkV5a1BBU3c0OVByRmtBSTVnVWIwaFAzNlBZUlZrUzhHMyt1WmVqeHJtUC9uY1JIQytDOFY1T2Y5NktxOWYxTVVLMG42cXlQWmsyUXo3WFFzVTJ4L1dpVVNKOWZBcE55eVp5TzF3bUtTZ1VDaUltSGNCTlc4RzBSaW1IaGhzRDU2MVUwL2lnSnQ1Z2hlblNKSE9PbUxBWWJ0OTN4WXVNWktJcHhOMk1aYjFkY0gvbWVlWlNwOEJhTTZvd0lEQVFBQm80SUJpekNDQVljd1JRWUlLd1lCQlFVSEFRRUVPVEEzTURVR0NDc0dBUVVGQnpBQmhpbG9kSFJ3Y3pvdkwyTmxjblJwWm1sallXTnBiMjR1WkdsbmFYUmhiQzVuYjJJdVkyd3ZiMk56Y0RBZEJnTlZIUTRFRmdRVUxuZ1dFcFJubXR6MG1qMmszSVBxK2o2NGlJUXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWZCZ05WSFNNRUdEQVdnQlJSU3VlYW8yUHB4L2RZOVJwZXpjTVh3NUoySGpBaEJnTlZIUklFR2pBWW9CWUdDQ3NHQVFRQndRRUNvQW9XQ0ZKVlZGOVNUMDlVTUVvR0ExVWRJQVJETUVFd1B3WUdZSUVZaDJrRE1EVXdNd1lJS3dZQkJRVUhBZ0VXSjJoMGRIQnpPaTh2Wm1seWJXRXVaR2xuYVhSaGJDNW5iMkl1WTJ3dlpHOWpkVzFsYm5SdmN6QkNCZ05WSFI4RU96QTVNRGVnTmFBemhqRm9kSFJ3Y3pvdkwyTmxjblJwWm1sallXTnBiMjR1WkdsbmFYUmhiQzVuYjJJdVkyd3ZZM0pzWDNKdmIzUXVZM0pzTUE0R0ExVWREd0VCL3dRRUF3SUJCakFxQmdOVkhSRUVJekFob0I4R0NDc0dBUVFCd1FFQm9CTVdFVkpWVkY5RFJWSlVTVVpKUTBGRFNVOU9NQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUUNXSFU2L1BabW5JR0N0d0tPMC9vZG5sSlo3ajRraXlPSVN3ODFoeE9ZTDIveXh0dTNqOWZ0MnZ6NkNPUUNPbWpvdnRoczBFcEduVjY2QVErWU8zTEgycGUzV2Y4VkxyTXFrS2hzN3pkeUx1MU0rcHBvRnRYOHgxNGhHdlBOdlVINTJqNXd0alVsZVc4YXhFU2ltNnFQOTJwdjE1a0lyOGhJSDdldWF3WktWelpKSjZ5S0tPU3VweUNXV3o2N1gzMDFkOXdDbmlBTW9xQU01bUNzdlk2Y2FVTWlEQmsrV2R6NGxlOW5TMHZaMDdJL3JyRythOFdzUlRhTURJY1FCaWlOdEQ1SUdhb0svd2tONzF1S3NUK2JadTEwdldMVHdHb3E0RzhMK0d0YmpObEFwMEZ0aG5JTWNSTXRFTDRxOVpvVURLeWtIeEl4Q0gzL0llUnFEcjlDVFxuLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLSIsIi0tLS0tQkVHSU4gQ0VSVElGSUNBVEUtLS0tLVxuTUlJRDdUQ0NBdFdnQXdJQkFnSUlUWmtKL3J2aVhXd3dEUVlKS29aSWh2Y05BUUVMQlFBd1RERWNNQm9HQ1NxR1NJYjNEUUVKQVJZTlUwOU5SVUJGVFVGSlRDNURUREVzTUNvR0ExVUVBd3dqUlU1VVNVUkJSQ0JTVDA5VUlFRk5Ra2xGVGxSRklFTkZVbFJKUmtsRFFVTkpUMDR3SGhjTk1UZ3hNakEzTVRVME5qUTRXaGNOTWpneE1qQTNNVFUwTmpRNFdqQk1NUnd3R2dZSktvWklodmNOQVFrQkZnMVRUMDFGUUVWTlFVbE1Ma05NTVN3d0tnWURWUVFERENORlRsUkpSRUZFSUZKUFQxUWdRVTFDU1VWT1ZFVWdRMFZTVkVsR1NVTkJRMGxQVGpDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBSmhycmhEWGRwTDdtWC9tSlpwTzdLN3V5TVJ2cUkyeE1yVWhOSnBGV056M1Q4NGFnVUcydWtzc01WaEE4Wk15bjhNbzdxQng3VEZsYjN0M3dnRDRwelI2TVhKcjdaYS9xSXZxTGJIMktVVWJQSy9oeGtHRHB1ZTMrcnhPUkFoS2dSTlYrNFN4dWZ1TmNkSjQ0cm1WR3ZVUlBGeVZFUU1DUVptYVYwd09ROStaWUR3ODZmNk53MUJud2FXRXRTSW1SODhGdk9xeHdJVURTSVVaNmFJUHNRM0RwL1BCNVpVMUVFQXBBQ3RwcUE1WXJ2RVAwc1J5ZGZicWtTM3JlbzNvU3owQVFCNGEybktZN2liWDBQa2kyOG9zenhxcEJOUlp0TEhjZExXY2VMS0hGYmtIM0kzSlRWb1pNc2JaZWtJNWhlZ0F6cmVZMEU3UGE3SjdpSzVtT29FQ0F3RUFBYU9CMGpDQnp6QWRCZ05WSFE0RUZnUVVVVXJubXFOajZjZjNXUFVhWHMzREY4T1NkaDR3RHdZRFZSMFRBUUgvQkFVd0F3RUIvekFmQmdOVkhTTUVHREFXZ0JSUlN1ZWFvMlBweC9kWTlScGV6Y01YdzVKMkhqQkpCZ05WSFNBRVFqQkFNRDRHQm1DQkdJZHBBekEwTURJR0NDc0dBUVVGQndJQkZpWm9kSFJ3Y3pvdkwyWnBjbTFoWld4bFkzUnliMjVwWTJFdVoyOWlMbU5zTDJOd2MxOW5NVEFPQmdOVkhROEJBZjhFQkFNQ0FRWXdJUVlEVlIwUkJCb3dHS0FXQmdnckJnRUVBY0VCQWFBS0ZnaFNWVlJmVWs5UFZEQU5CZ2txaGtpRzl3MEJBUXNGQUFPQ0FRRUFVL0liY2syMkJzRnloQXFYUzdQaHhTNllncWxaeDM3bHpXRzF4NUkycUpuS2k2Q2dlSDRTQWdaS3BGQ1d2SnZXLzZjSWNVTzg0MUUvbnpkR3FtaUZCNEV4WXlpc3B5eldkZjFiWW5zS2FzY0U5WnZxL3FQL0xOTHEwdFplbk8vaGQvRFB5VE9JdmVnYSs5a0F5dzVLVFQwVWtSNEw0TjBrOXRWQVZvUWw0L3BpampMR1BiOUdmV0FVTGZhWnNZRVZnd2xQSUZScllJVTZmUTRoS3JwM1hoeHVOR04xTFE2R0lZVEFQYWdRdVJ6NFRqMWNOYTJBcHlNNkdMdVBod0V3blc3bW95ZjlGcWdDRWZHckNzVVlTMnVuUDFKZndBTzczOEk3MFdONDNjazc4TXBIMzNORXhRd3N3S3JicW51VWpJV3JBcVdUekZhMTJzQVJZMWxjM3c9PVxuLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLSJdfQ.eyJzdWIiOiJEb2N1bWVudG8gZmlybWFkbyBwb3IgMjIyMjIyMjItMiIsIkRvY3VtZW50b0Zpcm1hZG8iOiJ7XCJrZXkxXCI6IFwidmFsdWUxXCIsXCJrZXkyXCI6IFwidmFsdWUyXCJ9In0.Rr1Odo3dxjrPg-fa9aynVql2BGnFBWDKWKXdlAXRovIAkztG3u-1WrSzecnP3QkHvvMqmerwWq57cGHWrTOrFzJjj_5bun82Ppo-JyDvnLqCfMQLbaY9yy9flDfAm61uojMvehJ0LT27hfEyxwgqKezT4cly2L_cdMUFnF0yc9fuyZJ1sTO-XElL7adA3_GWVbTDIKLHPEddH2LEDMpJv56hECl-0Ldkyl2zvYm059BDn4N02_NbhLw-qzXpxukn1yDi9jHDqUIFJhYsR7-cl0NGIChMDz6fLBvjFzmKSqgRt0rwivfA-RYU53pzWa1v9ruiT8GDFGOCOeeHB9Jytg"}",
"status": "OK",
"description": null,
"contentType": "application/json",
"documentStatus": "FIRMADO",
"checksum_original": "9971224dc8f574ec570ce9fa86f649e2fc26928f561d1649e16841432f9165ff"
}
],
"metadata": {
"otpExpired": false,
"filesSigned": 1,
"signedFailed": 0,
"objectsReceived": 1
},
"idSolicitud": 570880299954241865
}
En el campo files se recibe una lista de objetos, este contiene lo siguiente:
| checksum_original | SHA256 del archivo original. |
| status | error - no se concretó la firma |
| OK - transacción correcta | |
| content | base64 del archivo firmado |
En el campo metadata se recibe un objeto que contiene lo siguiente:
| signed_file | número de archivos firmados |
| OTP_expired | booleano que indica si el OTP se pudo usar de manera correcta con la totalidad de archivos |
| files_signed | Número de archivos que se pudieron firmar |
| files_recived | Número de archivos recibidos |
¶ 2. Ambiente de TEST
Las firmas generadas en este ambiente no son válidas, es sólo para facilitar la integración. Los datos entregados a continuación permiten realizar pruebas de firma de documentos.
URL: https://api.firma.cert.digital.gob.cl/firma/v2/files/tickets', método = ['POST']
¶ 2.1 Firma atendida
| api_token_key | sandbox |
| JWT |
{ "entity": "Subsecretaría General de la Presidencia", "run": "11111111", "expiration": "2021-11-15T17:31:00", "purpose": "Propósito General" } |
| secreto | 27a216342c744f89b7b82fa290519ba0 |
El código QR correspondiente a semilla para generar OTPs asociadas a este certificado es el siguiente:
En el Anexo A se detalla cómo realizar la instalación y configuración para la generación de OTPs.
¶ 2.2 Firma desatendida
| api_token_key | sandbox |
| JWT |
{ "entity": "Subsecretaría General de la Presidencia", "run": "22222222", "expiration": "2021-11-15T17:31:00", "purpose": "Desatendido" } |
| secreto | 27a216342c744f89b7b82fa290519ba0 |
En el caso de firma desatendida no debe enviarse el header OTP.
Una vez realizada las pruebas, la Institución puede solicitar el registro de su aplicación en el ambiente productivo en la siguiente url: Solicitud de Registros FirmaGob - opción registro de aplicación. Como resultado de dicha solicitud obtendrá los parámetros api_token_key y Secret que permitirán la integración con nuestra plataforma.
¶ 3. Códigos HTTP asociados a la API
|
Status code |
Tipo |
Response |
| 200 | Ok |
{ "files":[ { "content":"ARCHIVO BASE64 FIRMADO", "status":"OK", "contentType":"application/pdf", "description":"DESCRIPCION DE DOCUMENTO", "checksum_original":"CHECKSUM ENVIADO", "checksum_signed":"CHECKSUM FIRMANDO" } ], "metadata":{ "otpExpired":false, "filesSigned":1, "signedFailed":0, "objectsReceived":1 } } |
| 400 | Bad request |
{ "timestamp": "yyyy-MM-dd hh:mm:ss", "status": 400, "error": "Mensaje de Error*" } * Mensaje de Error, pueden ser los siguientes:
|
| 404 | Error de Recurso no Encontrado |
{ "timestamp": "yyyy-MM-dd hh:mm:ss", "status": 404, "error": "Mensaje de Error*" } *Mensaje de Error, pueden ser los siguientes:
|
| 412 | Error no autorizado |
{ "timestamp": "yyyy-MM-dd hh:mm:ss", "status": 401, "error": "Mensaje de Error*" } *Mensaje de Error, pueden ser los siguientes:
|
| 429 | Too Many Request |
{ "timestamp": "yyyy-MM-dd hh:mm:ss", "status": 429, "error": "Ha excedido el número máximo de intentos de OTP. Intente mas tarde" } |
| 500 | Error interno de servidor |
{ "timestamp": "yyyy-MM-dd hh:mm:ss", "status": 500, "error": "Internal Server Error" } |
| 502, 503, 504 | Error tiempo agotado de espera del Servidor |
{ "timestamp": "yyyy-MM-dd hh:mm:ss", "status": 504, "error": "Mensaje de Error" } Mensaje de Error, pueden ser los siguientes:
|
¶ Anexo A. Instalación aplicación móvil y configuración OTP
Es requisito habilitar una aplicación que permita generar un OTP válido al momento de realizar las pruebas al servicio. Por tal motivo, se ha habilitado una clave generadora de OTPs que permite utilizar un ambiente sandbox solo para la ejecución de pruebas.
A continuación se detallan los pasos a seguir para habilitar un generador de OTP en un smartphone.
¶ Aplicación OTP
Acceder a Google Play o App Store, descargar e instalar la aplicación Free OTP o Google Authenticator (para el ejemplo se ha utilizado un equipo con versión 5.1.1)
Abrir la aplicación ya instalada y habilitar la aplicación para la lectura de códigos QR.
Escanee el código QR.
¶ Anexo B. Configuración para incrustar firma a PDF
¶ Propiedad layout
La propiedad layout permite embeber una imagen asociada a la firma, análoga, de la persona que firma el documento electrónicamente. El siguiente XML muestra la estructura del layout.
<AgileSignerConfig>
<Application id=\"THIS-CONFIG\">
<pdfPassword/>
<Signature>
<Visible active=\"true\" layer2=\"false\" label=\"true\" pos=\"1\">
<llx></llx>
<lly></lly>
<urx></urx>
<ury></ury>
<page>LAST</page>
<image>BASE64</image>
<BASE64VALUE></BASE64VALUE>
</Visible>
</Signature>
</Application>
</AgileSignerConfig>
| Variable | Descripción | Tipo Valor |
| llx | Coordenada x de la esquina inferior izquierda de la imagen. | Número entero |
| lly | Coordenada y de la esquina inferior izquierda de la imagen. | Número entero |
| urx | Coordenada x de la esquina superior derecha de la imagen. | Número entero |
| ury | Coordenada y de la esquina superior derecha de la imagen. | Número entero |
| page | Número de página donde se incluirá la imagen con la firma. | Número entero. También es posible usar la palabra LAST para hacer referencia a la última hoja del documento. |
| image | Tipo de encoding utilizado para embeber la imagen | Texto. Valor constante a utilizar BASE64 |
| base64value | Contenido de la imagen con el formato y encoding definido anteriormente. |
Texto. Contenido del archivo en base64 |
Ejemplo:
Por restricciones de tamaño de archivo, el siguiente ejemplo no considera el contenido de la imagen. El ejemplo completo se encuentra publicado en RequestFirmaLayout.json
<AgileSignerConfig>
<Application id=\"THIS-CONFIG\">
<pdfPassword/>
<Signature>
<Visible active=\"true\" layer2=\"false\" label=\"true\" pos=\"1\">
<llx>250</llx>
<lly>300</lly>
<urx>350</urx>
<ury>450</ury>
<page>LAST</page>
<image>BASE64</image>
<BASE64VALUE></BASE64VALUE>
</Visible>
</Signature>
</Application>
</AgileSignerConfig>
¶
Anexo C. Definiciones y acrónimos
| Acrónimo | Definición |
| API | Application Programming Interface |
| APP | Aplicación |
| JSON | JavaScript Object Notation |
| JWT | JSON Web Token |
| SHA256 | hash criptográfico |
| OTP | One-Time Password |
| RA | Registration authority |
| XML | Extensible Markup Language |
| Término | Descripción |
| Firma atendida | Operación de firma en la cual se requiere la intervención del titular para la generación del OTP. |
| Firma desatendida | Operación de firma en la cual no se requiere la intervención del titular para la generación del OTP. |