La semana pasada, exploramos la estructura JSON de Rol y firmante , el significado detallado de estos dos conceptos, así como los métodos para recuperar ID para ellos en modo REST. En este blog, lo guiaré a través de los escenarios y las llamadas a la API en las que necesitará usar la ID de rol junto con la ID de firmante.

Para comenzar, resumamos brevemente Role y Signer:

• El firmante contiene información personal del usuario y se incluye en el Rol.
   
• El rol actúa como marcador de posición y está sujeto a las aprobaciones que están formadas por las firmas y campos de un firmante.

Si todavía está confundido o se perdió algo, puede consultar mi blog de la semana pasada, "Desarrollador de signos OneSpan: Rol vs firmante" o publicar una pregunta en nuestro Foro de desarrolladores.

 

Dónde usar la identificación del firmante

Recuerde, Signer está relacionado con la persona específica. La dirección de correo electrónico es lo único que identifica de forma exclusiva a un firmante, y la identificación del firmante puede reemplazarse por correo electrónico. Aquí hay dos escenarios en los que usa ID de firmante en el que se adhiere al correo electrónico del firmante:

 

Para recuperar el estado de firma:

OneSpan Sign le proporciona diferentes granos de búsqueda para el Estado de firma, lo que significa que puede verificar el estado de todo el paquete o solo para un firmante dentro de un documento específico. Opcionalmente, puede elegir los parámetros de firmante y documento en la siguiente URL de API para lograr esto:

GET / api / packages / {packageId} / SignatureStatus? Signer = {signerId} & document = {documentId}

 

Revisa esta publicación del foro para mas detalles.

 

Para recuperar el token de autenticación:

 

Se utiliza un token de autenticación para obtener una sesión válida para un firmante o para generar la URL de firma.

 

Hay tres llamadas API para recuperar authToken para un firmante:

POST / api / autenticaciónTokens / signer / singleUse

POST / api / autenticaciónTokens / signer / multiUse

POST / api / signerAuthenticationTokens

 

La primera llamada a la API es generar un solo uso del token de autenticación. Si bien las dos últimas API generan el uso múltiple de authToken para que pueda considerarlas como intercambiables, todas vienen con la misma carga útil de solicitud:

{

    "packageId": "su ID de paquete",

    "signerId": "ID del firmante o correo electrónico del firmante"

}

 

Aviso:

• Solo puede generar un token de autenticación para su firmante con el paquete en estado "ENVIADO". De lo contrario, recibirá un "error 400" que explica que este paquete está en un estado no válido.
   
• El correo electrónico del firmante también funciona en la carga útil de la solicitud.
   
• Todos los tokens de autenticación caducarán en 30 minutos.
   
• Tanto sessionToken (generado por authToken) como autenticaciónToken se pueden usar para generar URL de firma para un firmante reemplazando el marcador de posición en esta URL: https://sandbox.esignlive.com/access?sessionToken={signerAuthToken}

Dónde usar ID de rol

El ID de rol tiene un uso más amplio que el ID de firmante. En nuestro Sitio de especificación API , puede encontrar ejemplos detallados de servicios en los que se usa ID de rol:

1. Para gestionar un rol
    
2. Para reordenar un rol
    
3. Para desbloquear un firmante
    
4. Para enviar una invitación por correo electrónico para firmar
    
5. Para enviar un código de autenticación de SMS a un firmante

 

Además, también puede usar ID de rol en los siguientes escenarios:

 

Para generar la URL de firma para un firmante

Además de usar ID de firmante para generar una URL de firma, también puede seguir la API a continuación. La URL generada es diferente a la anterior y se puede usar varias veces. Esta URL es como la que recibiría el firmante en su correo electrónico. Probablemente no desee incrustar esta URL en el src de un iframe ya que no caduca.

GET / api / packages / {packageId} / roles / {roleId} / SignatureUrl

 

Para extraer la imagen de firma para un firmante

Una vez que su firmante capturó su firma, puede descargar la imagen de la firma y almacenarla en su propio sistema para su uso posterior. El tamaño predeterminado de la imagen descargada es de 350 x 100 píxeles, y esta función solo está disponible para la versión 11 de OneSpan Sign.

Solicitud HTTP

GET / api / packages / {packageId} / roles / {roleId} / signatureImage

Encabezados HTTP

Aceptar: image / png, image / jpeg, image / gif

Tipo de contenido: application / json

Autorización: Basic api_key

 

Si tiene alguna pregunta sobre este blog o cualquier otra cosa sobre la integración de OneSpan Sign en su aplicación, visite el Foros de la comunidad de desarrolladores . ¡Sus comentarios nos importan!