Este manual describe los pasos necesarios para integrar los servicios web en tu sistema de manera eficiente.
A continuación, se detallan los servicios en el orden en que deben ejecutarse, con una breve explicación de cada uno.
Resumen del Flujo Base:
Autenticación: Inicia sesión para obtener acceso (Paso 1). Creación del Proceso: Establece el marco inicial (Paso 2). Configuración del Proceso: Carga documentos, agrega títulos y define firmantes (Pasos 3, 4, 5, 6 y 7). Verificación y Recuperación: Consulta información y descarga documentos (Pasos 8, 9 y 10).
Descripción de Cada Proceso:
Inicio de Sesión
Propósito: Autenticar todas las solicitudes mediante una sesión válida.
Cómo funciona: Envía una solicitud POST con los tokens de usuario y datos de organización. La sesión tiene una duración de 5 minutos y está vinculada a la IP de origen.
Crear un Nuevo Proceso
Propósito: Registrar un proceso base en la plataforma.
Cómo funciona: Envía una solicitud POST con parámetros como categoría del proceso (idcat) y organización (idsol). Se puede personalizar el proceso asignando una aplicación específica (app).
Agregar Documentos
Propósito: Adjuntar documentos al proceso creado.
Cómo funciona: Sube archivos en formato PDF usando form-data, indicando el ID del proceso (idprc).
Agregar Título o Asunto
Propósito: Asignar un título o asunto descriptivo al proceso.
Cómo funciona: Actualiza un campo en el proceso utilizando el ID del proceso (idprc) y el valor del título (data).
Definir Número de Firmantes
Propósito: Especificar el número de firmantes requeridos en el proceso.
Cómo funciona: Envía el ID del proceso (idprc) junto con el número deseado de firmantes.
Agregar Firmantes
Propósito: Incluir a los participantes que firmarán los documentos.
Cómo funciona: Proporciona datos de los firmantes, como nombre, correo electrónico, tipo (tipo), y perfil (perfil).
Agregar Firmantes con Token (Opcional)
Propósito: Garantizar una mayor seguridad al incluir firmantes.
Cómo funciona: Utiliza un token único asociado al firmante para autenticación adicional.
Consultar Firmantes del Proceso
Propósito: Verificar la lista de firmantes incluidos en el proceso.
Cómo funciona: Envía el ID del proceso (idprc) para recuperar detalles de los firmantes.
Consultar Información del Proceso
Propósito: Obtener datos específicos de un proceso.
Cómo funciona: Utiliza el ID del proceso (idprc) y, si es necesario, un identificador de campo (aids) para obtener información detallada.
Consultar Documentos Generados
Propósito: Descargar los documentos generados durante el proceso.
Cómo funciona: Envía el ID del proceso (idprc) y recibe un archivo ZIP con los documentos asociados.
Parámetros necesarios:
idcat: Número del tipo de proceso a dar de alta
tipo: ID del tipo de contacto.
perfil: ID del tipo a dar de alta los usuarios firmantes.
org: Número de la organización.
org: Nombre de la organización. Este valor solo es necesario para setear sesión.
t003c002: Usuario iniciador del servicio.
t003c004: Password del usuario iniciador del servicio.
idsol: ID único del contacto t003c002.
key1: Token de acceso 1.
key2: Token de acceso 2.
app: Id de la aplicación a asignar el proceso.
2. Importante sobre las sesiones
Tiempo de sesión: La sesión es válida por 5 minutos. Después de este tiempo, se eliminará automáticamente.
Múltiples sesiones: Puedes tener varias sesiones abiertas al mismo tiempo, pero cada una tiene un límite de tiempo.
Vinculación con la IP: La sesión se vincula a la IP desde la cual se realiza el llamado. Si necesitas una IP fija, solicita este requerimiento a la mesa de control.
3. Consideraciones de seguridad
Seguridad del token: Asegúrate de que tu token de acceso esté protegido y solo se use en entornos seguros.
Sesión asociada a IP: Si usas una IP variable, asegúrate de que las solicitudes se hagan desde la misma IP durante la sesión.
Resumen
Obtención del Token
Propósito: Obtener el token de acceso y los datos de usuario necesarios para autenticar la sesión.
Cómo funciona: Realiza una solicitud POST al endpoint especificado para iniciar sesión, incluyendo el token y los parámetros necesarios en el header y el cuerpo de la solicitud.
Duración de la Sesión
Propósito: Establecer la duración de la sesión.
Cómo funciona: La sesión tiene una duración de 5 minutos y se vincula a tu IP. Si tu IP es variable, cada solicitud debe realizarse desde la misma IP para mantener la sesión activa.
¿Necesitas ayuda?
Si tienes dudas, contacta a soporte para un asesoramiento personalizado.
1) Logeo de usuario para alta de servicios
Para dar de alta cualquier servicio, será necesario establecer una sesión vinculada al usuario iniciador del servicio. Cada solicitud debe realizarse con esta sesión, ya que tiene una vigencia de 5 minutos. Es posible tener múltiples sesiones abiertas dentro del servicio, pero una vez transcurrido el plazo de 5 minutos, la sesión se descartará automáticamente, sin necesidad de realizar ninguna acción adicional.
La sesión estará asociada a la IP del servidor desde donde se realice la solicitud, la cual puede ser fija o variable. Si se requiere una IP fija por razones de seguridad, por favor, solicite este requerimiento a la mesa de control. Enviar solicitud de Logeo - Realiza una solicitud HTTP POST al siguiente endpoint.
https://portal.seguridata.com/resolve/rest/log/in
Para comenzar, el usuario debe abrir Postman, seleccionar el método POST en el campo de solicitud, e ingresar la URL de inicio de sesión para habilitar el proceso de autenticación.
Ejemplo Postman:
Realiza una solicitud HTTP POST al siguiente endpoint
Headers
Una vez que la URL esté configurada, es necesario agregar el parámetro org y las variables token1 del valor t003c002 y token2 de t003c004.
El cliente debe ingresar en la sección Headers• la siguiente clave y valor BASICclientbasic: y los token1*token2 separados con un asterisco en el medio:
Key
Value
Descripción
✓AUTHORIZATION
BASICclientbasic:vdsisdfixs*ssxtr131514tlsiosd
BASICclientbasic:token1*token2
Ejemplo Postman:
Headers
Body
En la sección Body•, asegúrese de seleccionar la opción x-www-form-urlencoded en la cual debe ingresar la org y las claves mencionadas anteriormente:
none
form-data
x-www-form-urlencoded
raw
binary
GraphQL
Key
Value
✓org
sandbox
✓t003c002
vdsisdfixs
✓t003c004
ssxtr131514tlsiosd
Ejemplo Postman:
Después, simplemente haga clic en el botón Enviar (Send) para enviar la solicitud. Este procedimiento se repetirá en cada paso: seleccionar POST, ingresar la URL correspondiente, agregar los parámetros necesarios, y presionar Enviar para avanzar a la siguiente pantalla o acción.
Respuesta:
✅ Respuesta exitosa: Responderá el idprc (número único en texto plano del proceso generado). ❌ Respuesta no exitosa: 0 o null
Ejemplo Postman:
2) Crear un nuevo proceso
Se recibirá una instrucción para que se den de alta un nuevo proceso de una organización y categoría de proceso indicada. Para dar de alta deberás:
Realiza una solicitud HTTP POST al siguiente endpoint.
En la sección Body•, siguiendo en el body x-www-form-urlencoded realiza las siguientes claves y valores:
none
form-data
x-www-form-urlencoded
raw
binary
GraphQL
Key
Value
Descripción
✓idcat
15
Valor variable proporcionada idcat (categoríad el proceso a dar de alta)
✓idsol
122
Valor variable proporcionada idsol (número del usuario a dar de alta el proceso)
Ejemplo Postman:
Respuesta:
✅ Respuesta exitosa: Responderá el idprc (número único en texto plano del proceso generado). ❌ Respuesta no exitosa: 0 o null
Ejemplo Postman:
2b) Crear un nuevo proceso | en especifico
Se recibirá una instrucción para que se dé de alta un nuevo proceso de una organización, categoría y aplicación en específico del proceso. Para dar de alta deberás:
Realiza una solicitud HTTP POST al siguiente endpoint.
En la sección Body•, seleccionamos nuevamente x-www-form-urlencoded y agregamos las siguientes claves y valores. (Solo en el paso anterior cambiamos a form-data para la carga del documento en formato file; en todos los demás pasos, utilizamos x-www-form-urlencoded).
none
form-data
x-www-form-urlencoded
raw
binary
GraphQL
Key
Value
Descripción
✓idprc
244
Valor idprc del proceso a actualizar
✓fld
p8
Campo a actualizar
✓data
Nombreprueba
Valor de data (información de entrada)
✓tipo
0
Tipo de campo (0 alfanumérico, 1 numérico)
Ejemplo Postman:
Respuesta:
✅ Respuesta exitosa: Responderá el idprc (número único en texto plano del proceso generado). ❌ Respuesta no exitosa: 0 o null
Ejemplo Postman:
5) Agregar número de firmantes
Realiza una solicitud HTTP POST al siguiente endpoint.
En la sección Body•, utilizando el formato x-www-form-urlencoded, agregue las siguientes claves y valores:
none
form-data
x-www-form-urlencoded
raw
binary
GraphQL
Key
Value
Descripción
✓idprc
244
Valor idprc del proceso a obtener archivo ZIP con los documentos relacionados al proceso de firma
Ejemplo Postman:
Respuesta:
✅ Respuesta exitosa: Responderá con un archivo ZIP que contiene los documentos relacionados con el proceso de firma. ❌ Respuesta no exitosa: 0 o null
Ejemplo Postman:
Soporte técnico
Para cualquier consulta, problema técnico o asistencia, por favor póngase en contacto con nuestro equipo de soporte técnico al correo electrónico. soporte@seguridata.com
Búsqueda de palabras clave
Guía para usar Servicios Web de SeguriData en Postman. Consulta los códigos a continuación:
Si necesita más información o asistencia adicional, no dude en ponerse en contacto con nosotros.
¡Gracias por confiar en nosotros!
