viafirma inbox :: manual de integración

prepareSignRequest

Prepara una petición de firma y devuelve la dirección a la que tendremos que redireccionar. Una vez enviada la petición de firma, la aplicación tendrá que redireccionar a una ventana de navegador a la url proporcionada en la repuesta de la llamada donde se solicitará el certificado digital del usuario que envía la petición para realizar la firma del fichero enviado. Tras proporcionar dicho certificado y realizar la firma del fichero, el usuario será redireccionado a la url de retorno proporcionada en la petición inicial. A modo resumen, la secuencia de pasos a seguir son los siguientes:

  1. Realizar una petición a prepareSignRequest pasando datos (firmante, fichero, etc.). En la respuesta viene una URL.
  2. Hacer redirect a esa URL (salto). El usuario será reenviado a la pantalla de firma donde tendrá que seleccionar su certificado.
  3. Cuando el usuario firma la petición, Inbox responde a la URL de retorno pasada en la llamada del paso 1. En esa URL Inbox pasa por querystring los siguientes datos:
    • res= ok si todo ha ido bien o errores (prticionnoexiste, usercancel, errorviafirma, …)
    • message= (si hay error, mensaje de error)
    • label= ID de la petición creada (Ej. R032-ICG9-RDD0-KWHR )

Parámetros

  • personId (String) (Obligatorio): PersonId del usuario remitente de la petición (deberá ser el mismo que luego seleccione su certificado)
  • documentName (String) (Obligatorio): Nombre del documento enviado
  • documentContent (byte[]) (Obligatorio): Byte array del documento enviado
  • returnUrl (String): Url donde se redireccionará al usuario al enviar la petición
  • notificationUrl (String): Url donde se notificarán los cambios realizado en la nueva petición creada.

Respuesta

SignRequestResponseDTO

  • redirectUrl: Url donde tendremos que redireccionar el navegador para que el usuario realice la firma del fichero.