Fya Corp API

1
1. Historial de Cambios del Documento 2
2. Dependencias 3
3. Resumen 4
4. Definiciones 5
5. Especificaciones Generales 7
6. MÓDULOS Y MÉTODOS 8
6.1. Personas y Grupos 8
6.1.1. Crear Grupo 8
6.1.2. Cargar Documento en un Grupo 12
6.1.3. Agregar Firmante 14
6.1.4. Quitar Firmante 18
6.1.5. Obtener un grupo 21
6.1.6. Activar Firmado en un grupo 24
6.1.7. Desactiva firmado de un grupo 27
6.1.8. Estado de un documento 29
6.1.9. Descarga de un documento 32
6.1.10. Activar verificación mediante CVE 34
6.1.11.Desactivar verificación mediante CVE 37
6.2. Callback de firma 38
1
2
1. Historial de Cambios del Documento
Versión Fecha Autor Descripción
1.0 06/07/2020 Santiago Camilo Primera Versión
2.0 27/07/2020 Santiago Camilo Segunda Versión
2.1 03/08/2020 Santiago Camilo Corrección
2.2 01/10/2020 Santiago Camilo Se agregan métodos
2.3 01/03/2021 Santiago Camilo Se depreca método
2.4 18/08/2021 Diego González Se agrega Callback y

modifica estilo del
documento.
2.4.1 23/09/2021 Diego González Se modifica ejemplo

erróneo en turn_on_signs
2.5 25/10/2021 Diego González Se agregan métodos CVE
2
3
2. Dependencias
Fecha Autor Descripción
18/06/2020 Santiago Camilo OPS-PRY 136.1 FYA - FirmaYa Corporativo
3
4
3. Resumen
El presente documento especifica el servicio de integración de la plataforma
FirmaYa mediante API de tipo REST, para ser consumida en aplicaciones del
cliente y las condiciones de soporte del servicio ofrecido.
4
5
4. Definiciones
Glosario de términos y acrónimos
● API: Una API es un conjunto de funciones y procedimientos que cumplen una o

muchas funciones con el fin de ser utilizadas por otro software. Las siglas API
vienen del inglés Application Programming Interface. En español sería Interfaz de
Programación de Aplicaciones.
● REST: (Representational State Transfer - Transferencia de Estado

Representacional) cualquier interfaz entre sistemas que use HTTP para obtener
datos o generar operaciones sobre esos datos en todos los formatos posibles,
como XML y JSON. Es una alternativa en auge a otros protocolos estándar de
intercambio de datos como SOAP (Simple Object Access Protocol), que disponen de
una gran capacidad pero también mucha complejidad.
● Token de autenticación: Hash con un valor único asociado a una identidad de

usuario del sistema.
● Soporte. Se refiere al servicio de asistencia al cliente para el uso de los sistemas

proporcionados por BPO Advisors.
● Agente del cliente. Se refiere a la contraparte del cliente que será el contacto
habilitado para la generación de solicitudes de atención de Soporte.
● Jefe de Proyecto. Ingeniero a cargo de la implementación del sistema, del área de

Operaciones.
● Ejecutivo Comercial. Encargado de la gestión comercial del contrato con el cliente

o del cierre de la venta.
● Incidencia. Se refiere a cualquier situación o requerimiento que requiera asistencia

de parte del Soporte.
● Control de Cambios. Procedimiento de solicitud de cambios en las funcionalidades

del sistema que no tengan relación a una falla o mal funcionamiento.
5
6
URL del servicio
El servicio se encontrará disponible mediante la siguiente URL:
https://firmaya.idok.cl/api/
6
7
5. Especificaciones Generales
● Todos los métodos que requieren parámetros obligatorios retornarán un mensaje
de error 422 si uno o varios de esos parámetros no son enviados.
● Todos los métodos pueden retornar el error 500 si ocurre algún error de
conectividad o por el estado del servicio.
● A no ser que se indique lo contrario, la identidad del autor de las peticiones será
el indicado de acuerdo al token de autenticación.
7
8
6. MÓDULOS Y MÉTODOS
Nota: Puede que los base64 en los ejemplos contengan entremedio un ‘[…]’ como forma
de mostrar que el valor está truncado; esto se realiza para que la documentación no se
extienda más de lo debido.
6.1. Personas y Grupos
Servicios orientados a la gestión de las personas y grupos donde se gestionará

posteriormente la firma de los documentos.
6.1.1. Crear Grupo
Genera la estructura básica que permite la firma de documentos. Los grupos son
el lugar lógico donde los titulares de la firma electrónica firmarán los
documentos.
URL : https://firmaya.idok.cl/api/corp/groups/create
Verbo HTML: POST
Headers
Nombre del campo Descripción
Content-Type Requerido. Valor fijo: “application/json”
Authorization Requerido. Token de Autenticación del usuario de

Integración, Administrador de la empresa o
Superadmin
8
9
Body
group_name Requerido. Identificador del grupo que se creará.
document_name Opcional. Nombre del documento, si se incluye de

inmediato en la creación del grupo.
members Opcional. Arreglo con la lista de personas (rut, email)

que podrá firmar un documento.
-> rut Requerido. Rut de la persona que podrá firmar.
-> email Opcional. Email de la persona que podrá firmar.

Requerido si se desea que el sistema notifique o invite
a la persona a firmar.
notify_users Requerido. Indica si se desea que el sistema notifique

directamente a las personas por correo electrónico.
url_redirect Opcional. Indica la URL de retorno para los procesos de

enrolamiento y firmado de todos los documentos de
este grupo.
pdf Opcional. Base64 del documento que se desea que

contenga el grupo.
Ejemplo (JSON):
{
"group_name": "[BUSINESS] Pruebas por api",
"document_name": "[BUSINESS] Doc por boomerang",
"members": [
{"rut":"11111111-1"},
{"rut":"22222222-2", "email": "falso@gmail.cl"},
{"rut":"33333333-3"}
],
"url_redirect": "https://www.google.cl/",
"notify_users": false,
"pdf":
"JVBERi0xLjYNJeLjz9MNCjI0IDAgb2JqDTw8L0ZpbHRlci9GbGF0ZURlY29k
ZS9GaXJzdCA0L0xlbmd0aCAyMTY vTiAxL1R5cGUvT2JqU3RtPj5zdHJl […]
DQo0NTc2DQolJUVPRg0K"
}
9
10
Retorno (JSON):
{
"id": "5ed045081028730e145c33f5",
"name": "[BUSINESS] Pruebas por api (2)",
"signs_allowed": false,
"members": [
{
"id": "5ec2bb391028731e28385de3",
"rut": "11111111-1",
"email": "email3@email.cl",
"status": "Enrolado"
},
{
"id": "5e7a63431028731d80d090bb",
"rut": "33333333-3",
"email": "email2@email.net",
}
],
"nonexistent_members": [
{
"rut": "22222222-2",
"email": "falso@gmail.cl",
"signup_url":
"https://signpass-plus.idok.cl/users/sign_in?hash=bklhaElJMk5
tODdYY3BWM2xJZG5jeHNBb3JwTlpvN2h
zdHByM2dRbndCS2ZPY04zT3l6OG1odnV0ZkJDaGJMRVRBRkdkWFpsOTMzbFpF
V3dWa0luZEJwR2YxdEtPY
1FTNWpjclRma3RKaitnNVdlbnBtV0kxYno2NDJURWZCSkliQ3p2Wm82QmJhVE
tjSndZYmx3MDlnPT0tLWY4
bzBub0NXamtzZUxLdFNXSnBMaVE9PQ%3D%3D--50d3b3fb4daf673300bbf6b
7abfe6492e236878e"
}
]
}
10
11
id Identificador único del grupo creado.
name Nombre del grupo creado.
signs_allowed Indica si el firmado está habilitado o no.
members Listado de los miembros del grupo (id, rut, email,

status) cuyo enrolamiento está completo o en proceso
-> id Identificador Único del usuario.
-> rut Rut de la persona que podrá firmar.
nonexistent_members Listado de los miembros del grupo (rut, email,

signup_url) que no están enrolados en la plataforma.
-> rut Rut del usuario.
-> email Email del usuario.
-> signup_url URL de enrolamiento del usuario.
Códigos de error:
HTTP Error Descripción
401 Credenciales Inválidas
401 Contraseña Incorrecta
422 Formato Rut Incorrecto
422 Formato de string base64 incorrecto.
502 Error al intentar conectar con un servidor externo.
11
12
6.1.2. Cargar Documento en un Grupo
Sube un documento a un grupo existente.
URL : https://firmaya.idok.cl/api/corp/groups/upload_pdf
Verbo HTML: POST
Headers

Superadmin
Body
id Requerido. Identificador del grupo.
document_name Requerido. Nombre del documento que se cargará.
pdf Requerido. Base64 del documento a cargar.
Ejemplo (JSON):
{
"id": "5ed02c571028730e145c33d8",
"document_name": "[BUSINESS] Doc en grupo preexistente",
"pdf":
ZS9GaXJzdCA0L0xlbmd0aCAyMTY vTiAxL1R5cGUvT2JqU3RtPj5 […]
lbmRvYmoNc3RhcnR4cmVmDQo0NTc2DQolJUVPRg0K"
}
12
13
Retorno (JSON):
{
"id": "5ed02c571028730e145c33d8",
"name": "[BUSINESS] Pruebas por api"
}
id Identificador del documento cargado.
name Nombre del grupo donde se cargó.
Códigos de error:
404 Grupo no encontrado.
13
14
6.1.3. Agregar Firmante
Agrega un miembro a la lista de firmantes de un grupo.
URL : https://firmaya.idok.cl/api/corp/groups/add_members
Verbo HTML: POST
Headers

Superadmin
Body
id Requerido. Identificador único del

grupo.
members Requerido. Listado de personas que se

agregan a la lista de firmantes de un
grupo.
-> rut Requerido.RUT del usuario
-> email Requerido. E-mail del usuario
notify_users Requerido. Indica si se desea que sea el

sistema quien notifique a los usuarios.
14
15
Ejemplo (JSON):
{
"id": "5ed02c571028730e145c33d8",
"members": [
{"rut":"11111111-1"},
{"rut":"12345678-5", "email": "email.1@mail.cl"},
{"rut":"98765432-1"}
],
"notify_users": false
}
Retorno (JSON):
{
"id": "5ed045081028730e145c33f5",
"name": "[BUSINESS] Pruebas por api (2)",
"signs_allowed": false,
"members": [
{
"id": "5ec2bb391028731e28385de3",
"rut": "11111111-1",
"email": "email@mail.cl",
}
],
{
"rut": "12345678-5",
"email": "email.1@mail.cl",
"signup_url":
"https://signpass-plus.idok.cl/users/sign_in?hash=bklhaElJMk5
tODdYY3BWM2xJZG5jeHNBb3JwTlpvN2hzdHByM2dRbndCS2ZPY04zT3l6OG1o
dnV0ZkJDaGJMRVRBRkdkWFpsOTMzbFpFV3dWa0luZEJwR2YxdEtPY1FTNWpjc
lRma3RKaitnNVdlbnBtV0kxYno2NDJURWZCSkliQ3p2Wm82QmJhVEtjSndZYm
x3MDlnPT0tLWY4bzBub0NXamtzZUxLdFNXSnBMaVE9PQ%3D%3D--50d3b3fb4
daf673300bbf6b7abfe6492e236878e"
},
{
"rut": "98765432-1",
"email": null,
"signup_url":
15
16
"https://signpass-plus.idok.cl/users/sign_in?hash=SERTOVBhYX
I2VUFlKzIya1lrMkxoOWw4SW1aYjFzSTRidSsreFF0UjV1Ty94RzJ2T2c4U3
pVdm1kUHNJSTk3YzBwQ1lseGlvUWZub2NTUXo0WXVvN01pSGVBekFERFBsYU
g0VkdJSmRGM3lqUUpTeTdvNVRiZmVlQmpFdUpiVFZRTmkwUGpCRndWRmI3OG
tvdkptOXpnPT0tLUdveElUVkk4Y2dCNmE5enJUMGpjUVE9PQ%3D%3D--da88
7c5c8eab55d2d0aca938efb7cdb861fbb51f" }
]
}
name Nombre del grupo creado
members Listado de los miembros del grupo (id,

rut, email, status) cuyo enrolamiento
está completo o en proceso
-> rut RUT del usuario
-> email e-mail del usuario
-> status Estado del usuario (creado, enrolado)
nonexistent_members Listado de los miembros del grupo (rut,

email, signup_url) que no están
enrolados en la plataforma.
-> email e-mail del usuario
Códigos de error:
16
17
422 Formato Rut Incorrecto
17
18
6.1.4. Quitar Firmante
Quita miembros de la lista de firmantes de un grupo.
URL : https://firmaya.idok.cl/api/corp/groups/remove_members
Verbo HTML: POST
Headers

Superadmin
Body
id Requerido. Identificador único del grupo.
members Requerido. Listado de personas que se quitan de la

lista de firmantes de un grupo.
-> rut Requerido. Rut del usuario.
Ejemplo (JSON):
{
"id": "5ed02c571028730e145c33d8",
"members": [
{"rut":"12345678-5"}
]
}
18
19
Retorno (JSON):
{
"id": "5ed02c571028730e145c33d8",
"name": "[BUSINESS] Pruebas por api",
"members": [
{
"id": "5ec2bb391028731e28385de3",
"rut": "11111111-1",
}
],
{
"rut": "98765432-1",
"email": null,
"signup_url":
"https://signpass-plus.idok.cl/users/sign_in?hash=U204NGZxSj
QycVpNTlVIN2hLYXUyU3o2TzNpaXBrYjE1
QjRiVHNTNmY5elJ3a0xnS21OVGhVOTZhT1hHcDFUY201V2JTNDVBMjR2VXN2
M0s2NTFrODh3d0RnbVVVQ3kwS29PUHNRL0FWUXdlOGdPN3hGTTk0cDVzLzJD
MkRmZVFBMjE3SnF1cmNVNG1SYzVYY29ZdVp3PT0tLTVQMWpWRjVRYmFLMzVm
UktTeTgySFE9PQ%3D%3D--d7e7167b02909be571b147576ceaa7788f6bae
7c"
}
]
}
19
20

status) cuyo enrolamiento está completo o en proceso.
status Estado del usuario (creado, enrolado)
nonexistent_members Listado de los miembros del grupo (rut, email,

Códigos de error:
422 Formato Rut Incorrecto o no encontrado.
20
21
6.1.5. Obtener un grupo
Obtiene los datos de un grupo.
URL : https://firmaya.idok.cl/api/corp/groups/show
Verbo HTML: POST
Headers

Superadmin
Body
id Requerido. Identificador único del grupo.
Ejemplo (JSON):
{
"id": "5ed02c571028730e145c33d8"
}
Retorno (JSON):
{
"id": "5ed02c571028730e145c33d8",
"members": [
21
22
{
"id": "5e7a63431028731d80d090bb",
"rut": "11111111-1",
}
],
{
"rut": "12345678-5",
"email": "email.1@mail.cl",
"signup_url":
"https://signpass-plus.idok.cl/users/sign_in?hash=b0ZvZmdlaTl
4OTRZZTRqT2VUOUo2U2FRczlvREhCUGJ3MmdOc0Z3MHQxOW9ZbnNBaUduRkpN
b0thR0xzaUlNcmpYR2x0TlQ3UDFaYjNERnZ3NG9CbG9XSGRoQldFVHZYSnRyO
StUcXZ3VXc5S2pNbVBudnRmOGp5WXZhUWRWa3llL2JXZkx3SFpTSFgwSGZJaE
p0VW1RPT0tLXZldzRjSTRTcE52dkY5aFNjQUJLRnc9PQ%3D%3D--d0339ad62
7f0581b182727762fc86b7ac1a4eaeb" },
{
"rut": "98765432-1",
"email": null,
"signup_url":
"https://signpass-plus.idok.cl/users/sign_in?hash=THZhZ2tLRTh
yRFJ5aEZDSHdFMVc2YkJwMU1kdzBQNTZFNzQ0VTQ2N1V1ZjJrN29RSUZqbVV5
Yk55SWpKQVBPOExIOW91SFd3RUpId3EvbHp5eTJYTTgzSXp2Qmk1Z1pUSGthc
itlL29tNkF5ZURZL3lEOWhubXNKeGkzbjlrblZFSDhxZSt5TDFFQk1mbVVoaT
dkczBnPT0tLXlWNE9Qam9yTjVrVjErUGFVUmV6RUE9PQ%3D%3D--1ef9be794
b909257c6e8044424ea0c19a26b58df" }
],
"documents": [
{
"id": "5ed02c5a1028730e145c33de",
"name": "[BUSINESS] Doc por boomerang"
},
{
"id": "5ed02f1a1028730e145c33e5",
"name": "[BUSINESS] Doc en grupo preexistente"
}
]
}
22
23

-> email Email del usuario
nonexistant_members Listado de los miembros del grupo (rut, email,

-> email E-mail del usuario
documents Listado de documentos del grupo (id, name).
-> id Identificador Único del documento.
-> name Nombre del documento
Códigos de error:
422 Formato ID Incorrecto o no encontrado
23
24
6.1.6. Activar Firmado en un grupo
Activa la etapa de firmado de los documentos de un grupo.
URL : https://firmaya.idok.cl/api/corp/groups/turn_on_signs
Verbo HTML: POST
Headers

Superadmin
Body
id Requerido. Id del grupo.
notify_users Requerido. Establece si se requiere que sea el sistema

quien notifique a los firmantes la activación de la etapa
de firma.
Ejemplo (JSON):
{
"id": "5ed02c571028730e145c33d8",
}
24
25
Retorno (JSON):
{
"id": "5ed02c571028730e145c33d8",
"signs_allowed": true,
"members": [
{
"id": "60f0765aedf4156b02de139",
"rut": "11111111-1",
"status": "Enrolado",
"documents": [
{
"id": "614cbc97502f6544a16f03130",
"name": "Doc blanco de prueba",
"sign_url":
"https://signpass-plus.idok.cl/sign_orders/614cbcfu97665d608b
ed6dfd0/login_to_sign"
}
]
}
]
}

-> email Email del usuario
25
26
--> documents Listado de documentos del grupo (id, name).
---> id Identificador Único del documento.
---> name Nombre del documento
---> sign_url URL para firmar el documento, por este usuario.
Códigos de error:
26
27
6.1.7. Desactiva firmado de un grupo
Desactiva la opción de que los miembros de un grupo puedan firmar documentos
dentro de ese grupo. URL :
https://firmaya.idok.cl/api/corp/groups/turn_off_signs
Verbo HTML: POST
Headers

Superadmin
Body
id Requerido. Id del grupo.
notify_users Requerido. Establece si se requiere que sea el sistema

quien notifique a los firmantes la desactivación de la
etapa de firmado.
Ejemplo (JSON):
{
"id": "5ed02c571028730e145c33d8",
}
27
28
Retorno (JSON):
{
"id": "5ed02c571028730e145c33d8",
"signs_allowed": false
}
id Identificador único del grupo.
name Nombre del grupo.
Códigos de error:
28
29
6.1.8. Estado de un documento
Obtiene el estado de un documento del sistema.
URL :
https://firmaya.idok.cl/api/corp/groups/document_status
Verbo HTML: POST
Headers

Superadmin
Body
mxml_id Requerido. Identificador único del documento.
Ejemplo (JSON):
{
"mxml_id": "5ed02c5a1028730e145c33de"
}
29
30
Response:
{
"id": "611424d1502d225200bd380a",
"created_at": "2021-08-11 19:28:17 UTC",
"updated_at": "2021-08-11 19:35:29 UTC",
"document_name": "Doc blanco",
"signs_allowed": true,
"group_id": "611424cf502d225200bd3805",
"creator_id": "5e7906c6cab6200c2111b983",
"signers": [
{
"id": "61142581502d225462a43c",
"rut": "11111111-1",
"email": "email@mail.cl"
}
]
}
id Identificador único del documento.
created_at Fecha de creación del documento.
updated_at Fecha de última actualización del documento.
document_name Nombre del documento.
signs_allowed Indica si la etapa de firma está activa.
group_id ID del grupo al que pertenece el documento.
creator_id ID del creador del documento.
signers Array de firmantes.
-> id ID del firmante.
-> rut RUT del firmante.
-> email E-mail del firmante.
30
31
Códigos de error:
31
32
6.1.9. Descarga de un documento
Obtiene un documento del sistema.
URL :
https://firmaya.idok.cl/api/corp/groups/download_document
Verbo HTML: POST
Headers

Superadmin
Body
Ejemplo (JSON):
{
"mxml_id": "5ed02c5a1028730e145c33de"
}
32
33
Response:
{
"id": "611424d1502d225200bd380a",
"pdf64":
ZS9GaXJzdCA0L0xlbmd0aCAyMTYvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NC
mjePI9RS8MwFIX/yn1bi9jepCQ6GYNpFBT […]
JIqeZA0mG8x9B7Om3wSQ3iFxRzgAG//8DAF56D6AKZW5kc3RyZWFtCmVuZG9i
agolaVRleHQtNS41LjYKc3RhcnR4cmVmCjEwODg3MAolJUVPRgo="
}
id Identificador único del documento.
pdf64 Documento en Base64.
Códigos de error:
33
34
6.1.10. Activar verificación mediante CVE
Activa la validación de un documento mediante un Código de Verificación

Electrónica (CVE) para que cualquier persona que posea el código, pueda ver el
documento en el validador en línea de FirmaYa
URL : https://firmaya.idok.cl/api/corp/mxmls/turn_on_cve_verification
Verbo HTML: POST
Headers

Superadmin
Body
Ejemplo (JSON):
{
"mxml_id": "5ed02c5a1028730e145c33de"
}
34
35
Response:
{
"mxml_id": "6176bd55edf4153d8beaecef",
"name": "[BUSINESS] Doc por boomerang",
"cve_verification_allowed": true
}
mxml_id Identificador único del documento.
name Nombre del documento.
cve_verification_allowed Boolean. Indica si está permitida la verificación.
Códigos de error:
404 Documento no encontrado
35
36
36
37
6.1.11.Desactivar verificación mediante CVE
Activa la validación de un documento mediante un Código de Verificación

Electrónica (CVE) para que cualquier persona que posea el código, pueda ver el
documento en el validador en línea de FirmaYa
URL : https://firmaya.idok.cl/api/corp/mxmls/turn_off_cve_verification
Verbo HTML: POST
Headers

Superadmin
Body
Ejemplo (JSON):
{
"mxml_id": "5ed02c5a1028730e145c33de"
}
37
38
Response:
{
"mxml_id": "6176bd55edf4153d8beaecef",
"name": "[BUSINESS] Doc por boomerang",
"cve_verification_allowed": false
}
mxml_id Identificador único del documento.
name Nombre del documento.
cve_verification_allowed Boolean. Indica si está permitida la verificación.
Códigos de error:
404 Documento no encontrado
38
39
6.2. Callback de firma
La plataforma puede realizar llamadas a un endpoint provisto por el cliente cada

vez que un documento se firma, notificando el ID del documento y el RUT del
usuario que acaba de firmar el documento.
El servicio envía los siguientes datos en el siguiente formato:
{
"id": "5ed02c5a1028730e145c33de",
"rut":"111111111-1"
}
id ID del documento firmado
rut RUT del usuario que firmó
Este método es informativo y no maneja respuestas.
39

Fya Corp API

Cargado por

Información del documento

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Fya Corp API

Cargado por

Copyright:

Formatos disponibles

1

1. Historial de Cambios del Documento 2

1. Historial de Cambios del Documento

Versión Fecha Autor Descripción

1.0 06/07/2020 Santiago Camilo Primera Versión

2.0 27/07/2020 Santiago Camilo Segunda Versión

2.1 03/08/2020 Santiago Camilo Corrección

2.2 01/10/2020 Santiago Camilo Se agregan métodos

2.3 01/03/2021 Santiago Camilo Se depreca método

2.4 18/08/2021 Diego González Se agrega Callback y

2.4.1 23/09/2021 Diego González Se modifica ejemplo

2.5 25/10/2021 Diego González Se agregan métodos CVE

Fecha Autor Descripción

18/06/2020 Santiago Camilo OPS-PRY 136.1 FYA - FirmaYa Corporativo

● API: Una API es un conjunto de funciones y procedimientos que cumplen una o

● REST: (Representational State Transfer - Transferencia de Estado

● Token de autenticación: Hash con un valor único asociado a una identidad de

● Soporte. Se refiere al servicio de asistencia al cliente para el uso de los sistemas

● Jefe de Proyecto. Ingeniero a cargo de la implementación del sistema, del área de

● Ejecutivo Comercial. Encargado de la gestión comercial del contrato con el cliente

● Incidencia. Se refiere a cualquier situación o requerimiento que requiera asistencia

● Control de Cambios. Procedimiento de solicitud de cambios en las funcionalidades

URL del servicio

El servicio se encontrará disponible mediante la siguiente URL:

6.1. Personas y Grupos

Servicios orientados a la gestión de las personas y grupos donde se gestionará

6.1.1. Crear Grupo

Verbo HTML: POST

Nombre del campo Descripción

Content-Type Requerido. Valor fijo: “application/json”

Authorization Requerido. Token de Autenticación del usuario de

Nombre del campo Descripción

group_name Requerido. Identificador del grupo que se creará.

document_name Opcional. Nombre del documento, si se incluye de

members Opcional. Arreglo con la lista de personas (rut, email)

-> rut Requerido. Rut de la persona que podrá firmar.

-> email Opcional. Email de la persona que podrá firmar.

notify_users Requerido. Indica si se desea que el sistema notifique

url_redirect Opcional. Indica la URL de retorno para los procesos de

pdf Opcional. Base64 del documento que se desea que

Nombre del campo Descripción

id Identificador único del grupo creado.

name Nombre del grupo creado.

signs_allowed Indica si el firmado está habilitado o no.

members Listado de los miembros del grupo (id, rut, email,

-> id Identificador Único del usuario.

-> rut Rut de la persona que podrá firmar.

nonexistent_members Listado de los miembros del grupo (rut, email,

-> rut Rut del usuario.

-> email Email del usuario.

-> signup_url URL de enrolamiento del usuario.

HTTP Error Descripción

401 Credenciales Inválidas

401 Contraseña Incorrecta

422 Formato Rut Incorrecto

422 Formato de string base64 incorrecto.

502 Error al intentar conectar con un servidor externo.

6.1.2. Cargar Documento en un Grupo

Sube un documento a un grupo existente.

Verbo HTML: POST

Nombre del campo Descripción

Content-Type Requerido. Valor fijo: “application/json”

Authorization Requerido. Token de Autenticación del usuario de

Nombre del campo Descripción