OneSpan Sign Como: Gerenciando remetentes

Haris Haidary, 15 de Março de 2016

O OneSpan Sign fornece a capacidade de adicionar remetentes à sua conta, permitindo que eles criem e enviem pacotes de documentos para assinatura. Como proprietário da conta, você terá acesso aos pacotes criados por seus remetentes. No entanto, você só poderá recuperar os pacotes criados por seus remetentes por meio dos SDKs / API. Se você deseja acessar a partir da interface do usuário os pacotes criados por seus remetentes, você precisará deles para delegar o acesso a você. Este também é o caso da situação inversa. Para obter mais informações sobre como delegar acesso, consulte este blog anterior .

Existem três tipos de remetentes: Proprietário, Administrador e Remetentes básicos. O proprietário é o titular da conta e não pode ser alterado. Um administrador pode convidar usuários para serem remetentes na conta e nomear remetentes como administradores. Todos os tipos de conta podem criar e enviar pacotes. Também é importante observar que um remetente só pode ser membro de uma conta. Neste blog, mostrarei como gerenciar seus remetentes com o OneSpan Sign Java SDK, .NET SDK e REST API.

Remetentes na interface do usuário

Antes de entrar no código, você deve localizar a seção remetentes na sua interface do usuário. Após fazer login na sua conta do OneSpan Sign, clique em CONTA na barra de ferramentas e depois na guia Remetentes. Depois de executar seu código, você deve encontrar seus remetentes aqui.

O código

Agora que nosso objetivo está definido, vamos começar com o código. Vou cobrir exatamente as mesmas informações para cada método. Sinta-se livre para pular para a seção que se aplica a você. O código completo deste blog pode ser encontrado no compartilhamento da comunidade de desenvolvedores: Java , .INTERNET e DESCANSAR . Java SDK Vou começar com o Java SDK. Para convidar um usuário para ser um remetente em sua conta, você precisará criar um AccountMember objeto. Em seguida, ligue para o seu OneSpan Sign AccountService para enviar o convite. Quando um novo remetente é convidado a ingressar em uma conta, ele é adicionado por padrão em um estado inativo. O remetente receberá um e-mail contendo um link no qual precisará clicar para ativar sua conta. Você pode pular a etapa de verificação definindo o status como ATIVO ao construir seu AccountMember objeto, se o remetente já tiver uma conta do 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 (membro);

Você também pode recuperar seus remetentes ligando para o seu OneSpan Sign AccountService . Abaixo está um código de exemplo de como recuperar todos os seus remetentes, que vem como uma página do OneSpan Sign, junto com seus e-mails e IDs. O ID do remetente é necessário para atualizar ou excluir um remetente. No código abaixo, o número de remetentes retornados no PageRequest está definido como 5. O número máximo de remetentes que você pode recuperar por página é 50. O primeiro valor no PageRequest (variável 'i') é o ponto de partida na lista geral de remetentes que devem ser retornados. Essa variável é incrementada à medida que avançamos em nossos remetentes para rastrear onde estamos na lista geral de remetentes.

int i = 1;
Mapear  accountMembers = client.getAccountService (). GetSenders (Direction.ASCENDING, new PageRequest (i, 5));
		
enquanto ( !accountMembers .está vazia()) {
para (entrada Map.Entry : accountMembers.entrySet ())
	{
		System.out.println (entry.getKey () + "/" + entry.getValue (). GetId ());
		i ++;
	}
accountMembers = client.getAccountService (). getSenders (Direction.ASCENDING, new PageRequest (i, 5));
}

Como mencionado acima, você precisará do ID do remetente para atualizar seu remetente. Observe que o endereço de email não pode ser atualizado depois que você cria seu remetente. Você precisará criar um novo remetente, neste caso.

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

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

Finalmente, aqui está um código de exemplo de como você criaria um pacote de documentos a ser enviado por um remetente específico da sua conta:

DocumentPackage packageToSend = PackageBuilder.newPackageNamed ("Exemplo de contrato de limpeza")
			.withSenderInfo (SenderInfoBuilder.newSenderInfo ("john.smith @example .com "))
			.withSigner (SignerBuilder.newSignerWithEmail ("mary.doe @example .com ")
					.withFirstName ("Mary")
					.withLastName ("Doe")
					.withCustomId ("client"))
			.withSigner (SignerBuilder.newSignerWithEmail ("john.smith @example .com ")
					.withFirstName ("John")
					.withLastName ("Smith")
					.withCustomId ("contratante"))
			.withDocument (DocumentBuilder.newDocumentWithName ("Contract.pdf")
					.fromStream (novo FileInputStream ("DOC_FILE_PATH"), DocumentType.PDF)
					.enableExtraction ())
				.Construir();

.NET SDK Em seguida, continuarei com o .NET SDK. Para convidar um usuário para ser um remetente em sua conta, você precisará criar um AccountMember objeto. Em seguida, ligue para o seu OneSpan Sign AccountService para enviar o convite. Quando um novo remetente é convidado a ingressar em uma conta, ele é adicionado por padrão em um estado inativo. O remetente receberá um e-mail contendo um link no qual precisará clicar para ativar sua conta. Você pode pular a etapa de verificação definindo o status como ATIVO ao construir seu AccountMember objeto, se o remetente já tiver uma conta do OneSpan Sign.

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

Você também pode recuperar seus remetentes ligando para o seu OneSpan Sign AccountService . Abaixo está um código de exemplo sobre como recuperar todos os seus remetentes, que vem como uma página do OneSpan Sign, junto com seus e-mails e IDs. O ID do remetente será necessário para atualizar ou excluir um remetente. No código abaixo, o número de remetentes retornados no PageRequest está definido como 5. O número máximo de remetentes que você pode recuperar por página é 50. O primeiro valor no PageRequest (variável 'i') é o ponto de partida na lista geral de remetentes que devem ser retornados. Essa variável é incrementada à medida que avançamos em nossos remetentes para rastrear onde estamos na lista geral de remetentes.

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

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

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

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

Finalmente, aqui está um código de exemplo de como você criaria um pacote de documentos a ser enviado por um remetente específico da sua conta:

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

API REST

Por fim, examinarei a API REST. Para convidar um usuário para ser um remetente em sua conta, você precisará criar o JSON abaixo. Então, você faz o seu POSTAR pedido para: https://sandbox.onespan.com/api/account/senders . Quando um novo remetente é convidado a ingressar em uma conta, ele é adicionado por padrão em um estado inativo. O remetente receberá um e-mail contendo um link no qual precisará clicar para ativar sua conta. Você pode pular a etapa de verificação definindo o status como ATIVO ao criar seu JSON, se o remetente já tiver uma conta do OneSpan Sign.

[code language = "javascript"] {"email": "john.smith @example .com "," firstName ":" John "," lastName ":" Smith "," company ":" ABC Bank "," title ":" CEO "," status ":" ATIVO "}

Você também pode recuperar seus remetentes fazendo um OBTER pedido para: https://sandbox.onespan.com/api/account/senders?from=0&to=10 . No meu exemplo, eu escolhi recuperar meus 10 primeiros remetentes. Você pode personalizar os parâmetros de consulta ao seu gosto. Para obter mais informações sobre os parâmetros de consulta disponíveis, acesse nosso documentação .

Para atualizar seu remetente, você precisará do seu ID de remetente, que pode ser recuperado da solicitação acima. Observe que o endereço de email não pode ser atualizado depois que você cria seu remetente. Você precisará criar um novo remetente nesse caso. Para atualizar seu remetente, faça uma POSTAR pedido para https://sandbox.onespan.com/api/account/senders/{senderId} com o seguinte JSON:

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

Da mesma forma, você também precisará do ID do remetente para excluir seu remetente. Se o remetente tiver pacotes na caixa de entrada ou no status de rascunho, o remetente será bloqueado em vez de excluído e não poderá criar ou enviar pacotes. Para excluir seu remetente, você precisará EXCLUIR pedido para: https://sandbox.onespan.com/api/account/senders/{senderId} .

Finalmente, aqui está um exemplo de JSON sobre como você criaria um pacote de documentos a ser enviado por um remetente específico da sua conta:

[code language = "javascript"] {"remetente": {"email": "john.smith @example .com "}," documents ": [{" extract ": true," name ":" Contract "}]," status ":" DRAFT "," papers ": [{" id ":" contractor "," digite ":" SENDER "," signatários ": [{" email ":" 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 ":" Exemplo de contrato de limpeza "}

Executando seu código

Agora você pode prosseguir e executar seu código. Você poderá ver os remetentes recém-criados na sua conta do OneSpan Sign, conforme mencionado no segmento "Remetentes na interface do usuário". Para os SDKs Java e .NET, incluí o código que imprime os e-mails e IDs dos remetentes. Abaixo está uma captura de tela da aparência da saída.

capturar

Se você tiver dúvidas sobre este blog ou qualquer outra coisa relacionada à integração do OneSpan Sign ao seu aplicativo, visite os fóruns da comunidade de desenvolvedores: https://developer.onespan.com . É isso de mim. Obrigado pela leitura! Se você achou esta publicação útil, compartilhe-a no Facebook, Twitter ou LinkedIn.

Haris Haidary
Evangelista Técnico Júnior
LinkedIn | Twitter

.INTERNET API blogue C # código desenvolvedor eSignLive como Java DESCANSAR SDK tutorial

Haris Haidary

OneSpan Blog

OneSpan Sign Como: Gerenciando remetentes

Remetentes na interface do usuário

O código

Comunidade de desenvolvedores OneSpan Sign

Executando seu código

OneSpan Sign Como: Criando um Modelo

Integração de assinatura eletrônica - um critério de seleção de chave

Dicas: Como extrair automaticamente campos de assinatura usando marcas de texto no sinal OneSpan