Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Este endpoint permite al cliente almacenar en su sistema los documentos asociados a diversos procesos utilizando el parámetro de callback que proporcionaron al crear generar la el proceso de firma.

Diagrama de secuencia para obtener un documento

Tener en cuenta

Info

Nota importante: Para que los clientes puedan utilizar nuestra API RESTrecibir el documento, es necesario que implementen un método tipo POST que pueda recibir el siguiente tipo de solicitudseguir los siguientes paso:

Paso 1: Preparar tu Servidor Web

Para comenzar, necesitas configurar un servidor web capaz de recibir solicitudes HTTP POST. Puedes elegir un lenguaje o marco de programación de tu preferencia, como Express.js (Node.js), Flask (Python), o cualquier otro que te resulte cómodo.

Paso 2: Crear un Endpoint para la Solicitud

Crea un endpoint en tu servidor web que escuche las solicitudes POST. Cuando recibas una solicitud, asegúrate de analizar el cuerpo JSON para extraer los siguientes campos:

Expand
titleRequest general para cualquier lenguaje de programación

Request general para cualquier lenguaje de programación

Code Block
languagejson
{
  "uuid": "string",
  "document": "Base64String"
}
Expand
titleRequest para Aura Portal

Request general para cualquier lenguaje de programación

Code Block
languagejson
{
  "uuid": "string",
  "document": "Base64String"
}
Expand
titleRequest para Process Maker

Request general para cualquier lenguaje de programación

Code Block
languagejson
{
  "uuid": "string",
  "document": "Base64String"
}

Paso 3: Procesar la Solicitud

Luego de extraer los datos de la solicitud, procede a realizar el procesamiento necesario. Ten en cuenta que la solicitud incluye un uuid y un documento en formato Base64. Decodifica el documento y procesa los datos de acuerdo con tus necesidades específicas.

Paso 4: Generar la Respuesta

Una vez que hayas completado el procesamiento de la solicitud, debes generar una respuesta JSON con el siguiente formato proporcionado.

Expand
titleResponse general

Ejemplo de una estructura de respuesta válida para Firma Seguro.

Response General

Code Block
languagejson
{
  "Message":"Intermediate event by message created correctly. ","MessageId":6012,"ProcessId":5571,"ProcessReference":"FIR-179.1_54"}"El documento de guardo correctamente",
  "Code": 200
}
Expand
titleResponse Aura Portal

Ejemplo de una estructura de respuesta válida para Firma Seguro.

Response General

Code Block
languagejson
{
  "Message":"El documento de guardo correctamente",
  "Code": 200
}
Expand
titleResponse Process Maker

Ejemplo de una estructura de respuesta válida para Firma Seguro.

Response General

Code Block
languagejson
{
  "Message":"El documento de guardo correctamente",
  "Code": 200
}

Paso 5: Gestión de Errores (Opcional)

Para garantizar una experiencia robusta, considera implementar un manejo de errores que aborde situaciones inesperadas, como solicitudes incorrectas o errores en el procesamiento. Esto puede incluir respuestas de error personalizadas y registros de errores.

Table of Contents
minLevel1
maxLevel6
outlinefalse
stylenone
typelist
printablefalse