Last modified: 2022-08-23

Integración

La sección Integración se compone de las siguientes páginas: 

Acceso a la API

Los clientes pueden comunicarse con OneSpan Sign desde su propio sistema mediante llamadas a la API REST. El sistema puede autenticar esas llamadas utilizando cualquiera de las siguientes técnicas:

  • Aplicaciones del cliente
  • Clave de API

Aplicaciones del cliente

Antes de que los integradores puedan realizar solicitudes a través de las API REST o funciones SDK, OneSpan Sign requiere que los usuarios registren Aplicaciones del cliente o proporcionen una Clave de API segura para autenticar las llamadas a la API.

Para registrar una aplicación de cliente

Puede autenticar las llamadas a la API REST desde el sistema de un usuario proporcionándole un token de API seguro pero de corta duración (por ejemplo, 30 minutos) que puede utilizarse para la autenticación. Esta función se llama Aplicaciones del cliente. Para activarla, debe comunicarse con nuestro Equipo de asistencia. Una vez activada esta función, los integradores externos podrán conectarse a la API de OneSpan Sign utilizando estos tokens de API.

Esta función no es compatible con conectores de OneSpan Sign.

Para crear una aplicación de cliente

  1. En la sección Aplicaciones del cliente de la página Acceso a la API, haga clic en Agregar. Aparece la barra lateral Crear aplicación del cliente.
  2. Escriba un Nombre para la aplicación del cliente.
  3. Haga clic en Crear.
  4. Copie los códigos de Identificación del cliente y Clave secreta que aparecen.
  5. Guarde los códigos de Identificación del cliente y Clave secreta en un lugar seguro.
  6. Haga clic en Listo.

La Clave secreta dejará de aparecer una vez que haga clic en Listo. Para sus registros, copie esta Clave secreta en un lugar seguro. La Identificación del cliente y la Clave secreta se utilizan para recuperar el token de API temporal.

Claves de API

Aunque se pueden utilizar claves de API con OneSpan Sign, recomendamos usar Aplicaciones del cliente en su lugar. Las aplicaciones del cliente son más versátiles y ayudan a reducir el número de vulnerabilidades de seguridad potenciales.

Las aplicaciones del cliente ofrecen las siguientes ventajas con respecto a las claves de API:

  • Con las aplicaciones del cliente se puede crear, rotar o revocar el acceso según sea necesario. Las claves de API son fijas y, por tanto, si desea realizar cualquier cambio de acceso, deberá comunicarse con nuestro Equipo de asistencia.

  • Se pueden utilizar varias aplicaciones del cliente si tiene configuradas varias integraciones. Esta posibilidad ayuda a limitar el alcance de cualquier ataque fraudulento a su sistema. En cambio, solo se proporciona una clave de API para todas las integraciones.

  • Las aplicaciones del cliente utilizan tokens temporales para permitir el acceso a la API, los cuales solo están disponibles durante un breve período de tiempo. Las claves de API no caducan y, por tanto, cualquier vulneración requerirá que se comunique con nuestro Equipo de asistencia.

Es posible que la clave de API no sea visible, dependiendo de su entorno y los privilegios de su cuenta.

Para ver su clave de API

  • En la sección Clave de API de la página Acceso a la API, haga clic en el ícono Ver.

De forma predeterminada, su clave de API está oculta.

Prevención de pérdida de datos (DLP)

Las Aplicaciones del cliente pueden se configurar para trabajar con el software de Prevención de pérdida de datos (DLP). Si utiliza un software DLP en su entorno y desea configurar su software para supervisar la Identificación del cliente y la clave secreta del cliente, contacte con nuestro Equipo de asistencia.

Notificaciones de eventos

OneSpan Sign permite que los integradores sean notificados automáticamente de los eventos que afectan a su cuenta. En eventos seleccionados, el sistema emite mensajes automáticamente a un destino elegido por el integrador. Antes de que OneSpan Sign le notifique sobre un evento, debe registrarse para recibir dicha notificación.

Para configurar Notificaciones de eventos en su cuenta:

  1. Introduzca Callback URL. Este campo es obligatorio.
  2. Opcionalmente, ingrese una Callback Key segura.
  3. Active los tipos de eventos para los que desee recibir notificaciones. De forma predeterminada, las notificaciones de todos los tipos de eventos están desactivadas.
  4. Haga clic en Guardar.
  5. Si cambió de opinión y quiere desactivar todas las notificaciones de eventos, haga clic en DESHACER.

    Si quiere activar la Notificación de eventos mediante el flujo de tokens de actualización de OAuth, debe hacerlo mediante una API. Tenga en cuenta que actualmente solo admitimos este método en Salesforce.

Seleccionar eventos

EventoDescripción
Transacción creadaSe creó una transacción.
Transacción caducadaUna transacción superó su fecha de caducidad.
Transacción activadaSe envió una transacción.
Transacción no realizadaUn destinatario optó por no firmar la transacción electrónicamente. La notificación incluye el motivo del destinatario para rechazarla.
Transacción desactivadaEl estado de la transacción cambió de ENVIADA a BORRADOR.
Adjunto de transacciónUn destinatario cargó un archivo adjunto.
Transacción lista para completarUna transacción se marcó como DO_NOT_AUTOCOMPLETE (no autocompletar) y fue firmada por todos los firmantes. La finalización de la transacción requiere una acción por parte del remitente.
Documento firmadoSe firma un documento y se acepta el contrato electrónico de consentimiento y divulgaciones.
Transacción completadaUna transacción fue completada por todos los firmantes, y el remitente la completó.
Rol reasignadoUn destinatario delegó su firma en otro firmante.
Transacción enviada a papelera de reciclajeSe movió una transacción a la carpeta Enviado a papelera de reciclaje.
El destinatario terminó de firmarUn destinatario terminó de firmar todos los documentos.
Transacción archivadaSe completó una transacción y se cambió al estado Archivado. Las transacciones archivadas ya no aparecen en el buzón de entrada ni en el tablero del usuario.
Transacción restablecidaUna transacción de la carpeta Enviado a papelera de reciclaje fue restaurada a su estado anterior.
Destinatario bloqueadoSe bloqueó a un destinatario debido a fallos repetidos de autenticación.
Transacción eliminadaSe eliminó permanentemente una transacción de la carpeta Enviado a papelera de reciclaje.
Error de KBAOcurrió un error de Autenticación basada en conocimiento.
Transacción rechazadaUn destinatario rechazó firmar la transacción. La notificación incluye el motivo del rechazo por parte del destinatario.
Correo electrónico devueltoSe devolvió un correo electrónico.
Was this information helpful?
X