OneSpan Sign Developer: Recuperar paquetes de remitente

Duo Liang, 1 de Agosto de 2018
Thumbnail

En este blog, lo guiaré a través de lo que podría haberse perdido en la Comunidad de desarrolladores de OneSpan Sign durante la semana del 22 de julio de 2018. Hoy, estamos cubriendo las diferencias entre los propietarios de cuentas y los remitentes. Sin más preámbulos, comencemos.


Propietario de cuenta vs remitente

Como propietario de una cuenta, OneSpan Sign le brinda la posibilidad de agregar remitentes a su cuenta principal, permitiéndole crear y enviar paquetes de documentos. 
Existen algunas diferencias entre el propietario de una cuenta y el remitente:

 

  1. Como propietario de una cuenta, en la interfaz de usuario web, cuando hace clic en la lista desplegable junto a su nombre en la parte superior de la pantalla, verá su rol como "Administrador". Sin embargo, los remitentes comunes estarán predeterminados para el papel de "Miembro".
     
  2. Solo el propietario de una cuenta tiene la opción "Administrador" en esta lista desplegable. Sin embargo, lo que discutiremos en este blog es que solo el propietario de una cuenta puede recuperar una clave API. Los remitentes no pueden obtener claves directamente a través de la interfaz de usuario web. Esto significa que los remitentes no pueden enviar una llamada API o llamar a las funciones SDK por sí mismas.

 

Cómo recuperar los paquetes y la información del remitente

Como propietario de una cuenta, debe preguntarse cómo administrar paquetes, plantillas y diseños para los remitentes, ya que no pueden recuperar su información mediante programación. A continuación se muestra una guía paso a paso para administrar estos elementos. 

1) Recupere la clave API del remitente

Para recuperar esta información, debe obtener la clave API de su remitente y usar este token para llamar a las API tal como lo hizo con su cuenta de propietario principal. Hay dos pasos para lograr esto:

Primero, recuperaría las ID del remitente de una de dos maneras. Lo siguiente tomará los primeros 50 remitentes de su cuenta, que puede recorrer para acceder a las ID de los remitentes:

OBTENGA https://sandbox.esignlive.com/api/account/senders?from=0&to=50.

 

Si solo está interesado en un solo remitente, puede hacer una búsqueda directa de ese remitente con la siguiente llamada:

OBTENGA https://sandbox.esignlive.com/api/account/senders?search={signerEmail}

 

Luego, una vez que tenga la ID del remitente, puede usar la API a continuación para recuperar la clave API del remitente actual. Aunque mencionamos que los remitentes no pueden ver sus claves API por sí mismos, OneSpan Sign tiene una clave asignada a cada remitente y, como propietario de una cuenta, puede recuperarlas mediante:

OBTENGA https://sandbox.esignlive.com/api/account/senders/{senderId}/apiKey 

 

Tenga en cuenta que, esta función actualmente solo está disponible a través de REST API.

 

2)    Recuperar lista de diseños

GET / api / layouts? From = {fromLayout} & to = {toLayout}


Autorización: básica {la clave de API de su remitente}


3)    Recuperar lista de ID de paquete

Puede usar la siguiente llamada API para recuperar directamente los paquetes para un remitente específico. Recuerde, esta llamada a la API solo devuelve paquetes creados bajo el propietario de la cuenta principal si está utilizando una clave de API del propietario. Por lo tanto, debe colocar la clave del remitente en el encabezado de la solicitud. 


GET / api / packages? Query = {status} & from = {fromPackage} & to = {toPackage}

Autorización: básica {la clave de API de su remitente}


Alternativamente, puede simplemente usar la función de Informe de finalización para recuperar todos los ID de paquete de los remitentes. Con esta estrategia, no necesariamente necesita obtener la clave API del remitente.

GET / api / reports / complete? Status = {status} & from = {fromDate} & to = {toDate}
Autorización: básica {clave del propietario de la cuenta}

 

Búsqueda de palabras clave


OneSpan Sign le brinda la capacidad de filtrar los resultados recuperados por palabras clave. Simplemente puede agregar un parámetro "& search = {keyword}" a su llamada a la API para los siguientes tres escenarios:


Para recuperar paquetes:
GET / api / packages? Search = {keyword} & from = {fromPackage} & to = {toPackage}

 

Para recuperar plantillas:
GET / api / packages? Type = TEMPLATE & search = {keyword} & from = {fromTemplate} & to = {toTemplate}


Para recuperar diseños:
GET / api / layouts? Search = {keyword} & from = {fromLayout} & to = {toLayout}

 

Aviso:


1) La plantilla es un tipo de paquete con el tipo de "plantilla"

2) En una URL, el valor de los parámetros de palabra clave y tipo (que es la plantilla aquí) no distingue entre mayúsculas y minúsculas. A diferencia del parámetro de estado, que indica el estado del paquete. Por ejemplo, "BORRADOR" o "ENVIADO" deben escribirse en mayúsculas.

3) "De" y "a" en las búsquedas anteriores son números enteros que corresponden al orden del paquete / plantilla / diseño en la lista de elementos.
Alternativamente, puede utilizar las funciones del SDK junto con parámetros relacionados para lograr el mismo objetivo que no sea el de recuperar las claves API de los remitentes.

 

Si tiene preguntas sobre este blog o cualquier otra cosa relacionada con la integración de OneSpan Sign en su aplicación, visite el Foros de la comunidad de desarrolladores