OneSpan Sign Cómo: Administrar remitentes

OneSpan Sign le brinda la posibilidad de agregar remitentes a su cuenta, lo que les permite crear y enviar paquetes de documentos para su firma. Como propietario de una cuenta, tendrá acceso a los paquetes creados por sus remitentes. Sin embargo, solo podrá recuperar los paquetes creados por sus remitentes a través de los SDK / API. Si desea acceder desde la interfaz de usuario a los paquetes creados por sus remitentes, necesitará que sus remitentes le deleguen el acceso. Este es también el caso de la situación inversa. Para obtener más información sobre cómo delegar el acceso, consulte esto blog anterior .

Hay tres tipos de remitentes: Propietario, Administrador y Remitentes básicos. El propietario es el titular de la cuenta y no se puede cambiar. Un administrador puede invitar a los usuarios a ser remitentes en la cuenta y designar a los remitentes como administradores. Todos los tipos de cuenta pueden crear y enviar paquetes. También es importante tener en cuenta que un remitente solo puede ser miembro de una cuenta. En este blog, le mostraré cómo administrar sus remitentes con OneSpan Sign Java SDK, .NET SDK y REST API.

Remitentes en la IU

Antes de ingresar al código, debe ubicar la sección de remitentes en su IU. Después de iniciar sesión en su cuenta de OneSpan Sign, haga clic en CUENTA en su barra de herramientas y luego en la pestaña Remitentes. Después de ejecutar su código, debe encontrar sus remitentes aquí.

El código

Ahora que nuestro objetivo está establecido, comencemos con el código. Cubriré exactamente la misma información para cada método. Siéntase libre de pasar a la sección que le corresponde. El código completo de este blog se puede encontrar en el código compartido de la comunidad de desarrolladores: Java , .RED y DESCANSO . SDK de Java Comenzaré con el SDK de Java. Para invitar a un usuario a ser un remitente en su cuenta, deberá crear un AccountMember objeto. Luego, llama a tu OneSpan Sign Servicio de cuenta para enviar la invitación Cuando se invita a un nuevo remitente a unirse a una cuenta, se agregan de manera predeterminada en un estado inactivo. El remitente recibirá un correo electrónico con un enlace en el que deberá hacer clic para activar su cuenta. Puede omitir el paso de verificación estableciendo el estado en ACTIVO cuando construyes tu AccountMember objeto, si su remitente ya tiene una cuenta de OneSpan Sign.

AccountMember member = AccountMemberBuilder.newAccountMember ("john.smith @example .com ")
				.withFirstName ("John")
				.withLastName ("Smith")
				.withCompany ("ABC Bank")
				.withTitle ("CEO")
				.withStatus (SenderStatus.ACTIVE)
				.construir();
		
client.getAccountService (). inviteUser (miembro);

También puede recuperar sus remitentes llamando a su OneSpan Sign Servicio de cuenta . A continuación se muestra un código de muestra sobre cómo recuperar todos sus remitentes, que viene como una página de OneSpan Sign, junto con sus correos electrónicos e identificadores. Se requiere la identificación del remitente para actualizar o eliminar un remitente. En el siguiente código, el número de remitentes devueltos en el Solicitud de página se establece en 5. El número máximo de remitentes que puede recuperar por página es de 50. El primer valor en el Solicitud de página (variable 'i') es el punto de partida en la lista general de remitentes que deben devolverse. Esta variable se incrementa a medida que avanzamos por nuestros remitentes para realizar un seguimiento de dónde estamos en la lista general de remitentes.

int i = 1;
Map  accountMembers = client.getAccountService (). GetSenders (Direction.ASCENDING, new PageRequest (i, 5));
		
mientras ( !accountMembers .esta vacio()) {
for (Map.Entry  entry: accountMembers.entrySet ())
	{
		System.out.println (entry.getKey () + "/" + entry.getValue (). GetId ());
		i ++;
	}
accountMembers = client.getAccountService (). getSenders (Direction.ASCENDING, nueva PageRequest (i, 5));
}

Como se mencionó anteriormente, necesitará la ID del remitente para actualizar su remitente. Tenga en cuenta que la dirección de correo electrónico no se puede actualizar una vez que haya creado su remitente. Deberá crear un nuevo remitente, en este caso.

SenderInfo updatedSenderInfo = SenderInfoBuilder.newSenderInfo ("john.smith @example .com ")
                .withName ("John", "Smith")
                .withTitle ("CEO")
                .withCompany ("Banco XYZ")
                .construir();
 
client.getAccountService (). updateSender (updatedSenderInfo, "{senderId}");

Del mismo modo, también necesitará la ID del remitente para eliminarlo. Si su remitente tiene paquetes en su bandeja de entrada o en estado de borrador, el remitente se bloqueará en lugar de eliminarse y ya no podrá crear ni enviar paquetes.

client.getAccountService (). deleteSender ("{senderId}");

Finalmente, aquí hay un código de muestra sobre cómo crearía un paquete de documentos para que un remitente particular lo envíe desde su cuenta:

DocumentPackage packageToSend = PackageBuilder.newPackageNamed ("Ejemplo de contrato de limpieza")
			.withSenderInfo (SenderInfoBuilder.newSenderInfo ("john.smith @example .com "))
			.withSigner (SignerBuilder.newSignerWithEmail ("mary.doe @example .com ")
					.withFirstName ("Mary")
					.withLastName ("Doe")
					.withCustomId ("cliente"))
			.withSigner (SignerBuilder.newSignerWithEmail ("john.smith @example .com ")
					.withFirstName ("John")
					.withLastName ("Smith")
					.withCustomId ("contratista"))
			.withDocument (DocumentBuilder.newDocumentWithName ("Contract.pdf")
					.fromStream (nuevo FileInputStream ("DOC_FILE_PATH"), DocumentType.PDF)
					.enableExtraction ())
				.construir();

.NET SDK A continuación, continuaré con .NET SDK. Para invitar a un usuario a ser un remitente en su cuenta, deberá crear un AccountMember objeto. Luego, llama a tu OneSpan Sign Servicio de cuenta para enviar la invitación Cuando se invita a un nuevo remitente a unirse a una cuenta, se agregan de manera predeterminada en un estado inactivo. El remitente recibirá un correo electrónico con un enlace en el que deberá hacer clic para activar su cuenta. Puede omitir el paso de verificación estableciendo el estado en ACTIVO cuando construyes tu AccountMember objeto, si su remitente ya tiene una cuenta de OneSpan Sign.

AccountMember member = AccountMemberBuilder.NewAccountMember ("price9872 @gmail .com ")
				.WithFirstName ("John")
				.WithLastName ("Smith")
				.WithCompany ("Banco ABC")
				.WithTitle ("CEO")
				.WithStatus (SenderStatus.ACTIVE)
				.Construir();
		
client.AccountService.InviteUser (miembro);

También puede recuperar sus remitentes llamando a su OneSpan Sign Servicio de cuenta . A continuación se muestra un código de muestra sobre cómo recuperar todos sus remitentes, que viene como una página de OneSpan Sign, junto con sus correos electrónicos e identificadores. Se requerirá la identificación del remitente para actualizar o eliminar un remitente. En el siguiente código, el número de remitentes devueltos en el Solicitud de página se establece en 5. El número máximo de remitentes que puede recuperar por página es de 50. El primer valor en el Solicitud de página (variable 'i') es el punto de partida en la lista general de remitentes que deben devolverse. Esta variable se incrementa a medida que avanzamos por nuestros remitentes para realizar un seguimiento de dónde estamos en la lista general de remitentes.

int i = 1;
IDictionary  accountMembers = client.AccountService.GetSenders (Direction.ASCENDING, new PageRequest (i, 5));

while (accountMembers.Count! = 0)
{
foreach (KeyValuePair  entrada en accountMembers)
      	{
        		Debug.WriteLine (entry.Key + "/" + entry.Value.Id);
                i ++;
       	}
      	accountMembers = client.AccountService.GetSenders (Direction.ASCENDING, new PageRequest (i, 5));
}

Como se mencionó anteriormente, necesitará la ID del remitente para actualizar su remitente. Tenga en cuenta que la dirección de correo electrónico no se puede actualizar una vez que haya creado su remitente. Deberá crear un nuevo remitente en este caso.

SenderInfo updatedSenderInfo = SenderInfoBuilder.NewSenderInfo ("john.smith @example .com ")
                .WithName ("John", "Smith")
                .WithTitle ("CEO")
                .WithCompany ("Banco XYZ")
                .Construir();
 
client.AccountService.UpdateSender (updatedSenderInfo, "{senderId}");

Del mismo modo, también necesitará la ID del remitente para eliminarlo. Si su remitente tiene paquetes en su bandeja de entrada o en estado de borrador, el remitente se bloqueará en lugar de eliminarse y ya no podrá crear ni enviar paquetes.

client.AccountService.DeleteSender ("{senderId}");

Finalmente, aquí hay un código de muestra sobre cómo crearía un paquete de documentos para que un remitente particular lo envíe desde su cuenta:

DocumentPackage packageToSend = PackageBuilder.NewPackageNamed ("Ejemplo de contrato de limpieza")
                .WithSenderInfo (SenderInfoBuilder.NewSenderInfo ("john.smith @example .com "))
                .WithSigner (SignerBuilder.NewSignerWithEmail ("mary.doe @example .com ")
                        .WithFirstName ("Mary")
                        .WithLastName ("Doe")
                        .WithCustomId ("cliente"))
                .WithSigner (SignerBuilder.NewSignerWithEmail ("john.smith @example .com ")
                        .WithFirstName ("John")
                        .WithLastName ("Smith")
                        .WithCustomId ("contratista"))
                .WithDocument (DocumentBuilder.NewDocumentNamed ("Contract.pdf")
                        .FromStream (nuevo FileStream ("DOC_FILE_PATH", FileMode.Open), DocumentType.PDF)
                        .EnableExtraction ())
                .Construir();

 

API REST

Por último, revisaré la API REST. Para invitar a un usuario a ser un remitente en su cuenta, deberá compilar el JSON a continuación. Entonces, haces tu ENVIAR solicitud de: https://sandbox.onespan.com/api/account/senders . Cuando se invita a un nuevo remitente a unirse a una cuenta, se agregan de manera predeterminada en un estado inactivo. El remitente recibirá un correo electrónico con un enlace en el que deberá hacer clic para activar su cuenta. Puede omitir el paso de verificación estableciendo el estado en ACTIVO al crear su JSON, si su remitente ya tiene una cuenta de OneSpan Sign.

[código idioma = "javascript"] {"correo electrónico": "john.smith @example .com "," firstName ":" John "," lastName ":" Smith "," company ":" ABC Bank "," title ":" CEO "," status ":" ACTIVE "}

También puede recuperar sus remitentes haciendo un OBTENER solicitud de: https://sandbox.onespan.com/api/account/senders?from=0&to=10 . En mi ejemplo, elegí recuperar mis primeros 10 remitentes. Puede personalizar los parámetros de consulta a su gusto. Para obtener más información sobre los parámetros de consulta disponibles, diríjase a nuestro documentación .

Para actualizar su remitente, necesitará su ID de remitente, que puede recuperar de la solicitud anterior. Tenga en cuenta que la dirección de correo electrónico no se puede actualizar una vez que haya creado su remitente. Deberá crear un nuevo remitente en este caso. Para actualizar su remitente, realice un ENVIAR solicitud de https://sandbox.onespan.com/api/account/senders/{senderId} con el siguiente JSON:

[code language = "javascript"] {"firstName": "John", "lastName": "Smith", "company": "XYZ Bank", "title": "CEO",}

Del mismo modo, también necesitará la ID del remitente para eliminarlo. Si su remitente tiene paquetes en su bandeja de entrada o en estado de borrador, el remitente se bloqueará en lugar de eliminarse y no podrá crear ni enviar paquetes. Para eliminar su remitente, deberá ELIMINAR solicitud de: https://sandbox.onespan.com/api/account/senders/{senderId} .

Finalmente, aquí hay un ejemplo de JSON sobre cómo crearía un paquete de documentos para que un remitente particular lo envíe desde su cuenta:

[código idioma = "javascript"] {"remitente": {"correo electrónico": "john.smith @example .com "}," documentos ": [{" extracto ": verdadero," nombre ":" Contrato "}]," estado ":" BORRADOR "," roles ": [{" id ":" contratista "," escriba ":" ENVIADOR "," firmantes ": [{" correo electrónico ":" john.smith @example .com "," firstName ":" John "," lastName ":" Smith "," id ":" contractor "}]," name ":" contractor "}, {" id ":" client "," type ":" SIGNER "," signers ": [{" email ":" mary.doe @example .com "," firstName ":" Mary "," lastName ":" Doe "," id ":" client "}]," name ":" client "}]," type ":" PACKAGE "," name ":" Ejemplo de contrato de limpieza "}

Ejecutando su código

Ahora puede seguir adelante y ejecutar su código. Debería poder ver sus remitentes recién creados en su cuenta de OneSpan Sign, como se menciona en el segmento "Remitentes en la interfaz de usuario". Para los SDK de Java y .NET, he incluido el código que imprime los correos electrónicos y los identificadores del remitente. A continuación se muestra una captura de pantalla de cómo se ve la salida.  

Si tiene preguntas sobre este blog o cualquier otra cosa relacionada con la integración de OneSpan Sign en su aplicación, visite los foros de la comunidad de desarrolladores: https://developer.onespan.com . Eso es todo de mi parte. ¡Gracias por leer! Si esta publicación le parece útil, compártala en Facebook, Twitter o LinkedIn.

Haris Haidary
Evangelista Técnico Junior
LinkedIn El | Gorjeo