OneSpan Signハウツー:送信者の管理

Haris Haidary, 2016年3月15日

OneSpan Signを使用すると、送信者をアカウントに追加して、署名用のドキュメントパッケージを作成して送信できます。アカウント所有者は、送信者が作成したパッケージにアクセスできます。ただし、SDK / APIを介して送信者が作成したパッケージのみを取得できます。送信者が作成したパッケージにUIからアクセスする場合は、送信者にアクセス権を委任する必要があります。これは逆の状況にも当てはまります。アクセスの委任の詳細については、こちらを参照してください前のブログ

送信者には、所有者、管理者、および基本的な送信者の3つのタイプがあります。所有者はアカウント所有者であり、変更できません。管理者は、ユーザーをアカウントの送信者に招待し、送信者を管理者として指定できます。すべての種類のアカウントでパッケージを作成して送信できます。また、送信者は1つのアカウントのメンバーにしかなれないことに注意することも重要です。このブログでは、OneSpan Sign Java SDK、.NET SDK、およびREST APIを使用して送信者を管理する方法を紹介します。

UIの送信者

コードに入る前に、UIで送信者セクションを見つける必要があります。OneSpan Signアカウントにログインした後、ツールバーの[アカウント]をクリックし、[送信者]タブをクリックします。コードを実行した後、ここで送信者を見つける必要があります。ui

コード

目標が設定されたので、コードから始めましょう。それぞれの方法でまったく同じ情報を扱います。該当するセクションに進んでください。このブログの完全なコードは、開発者コミュニティコードシェアにあります。ジャワ 。ネット 、および残り Java SDK まず、Java SDKから始めます。ユーザーをアカウントの送信者として招待するには、 AccountMember オブジェクト。次に、OneSpan Signを呼び出します AccountService 招待状を送信します。新しい送信者がアカウントに参加するように招待されると、デフォルトで非アクティブな状態で追加されます。送信者は、アカウントをアクティブにするためにクリックする必要があるリンクを含むメールを受信します。ステータスを次のように設定すると、確認手順をスキップできますアクティブあなたを構築するとき AccountMember オブジェクト(送信者が既にOneSpan Signアカウントを持っている場合)。

AccountMemberメンバー= AccountMemberBuilder.newAccountMember( "john.smith @example .com ")
				.withFirstName( "ジョン")
				.withLastName( "スミス")
				.withCompany( "ABC Bank")
				.withTitle( "CEO")
				.withStatus(SenderStatus.ACTIVE)
				.build();
		
client.getAccountService()。inviteUser(member);

OneSpan Signを呼び出して送信者を取得することもできます AccountService 。以下は、すべての送信者を取得する方法のサンプルコードです。これは、OneSpan Signからのページとして、電子メールとIDとともに送信されます。送信者のIDは、送信者を更新または削除するために必要です。以下のコードでは、返される送信者の数 PageRequest 5に設定されます。ページごとに取得できる送信者の最大数は50です。の最初の値 PageRequest (変数 'i')は、返される必要のある送信者のリスト全体の開始点です。この変数は、送信者のリスト全体のどこにいるかを追跡するために送信者をステップスルーするときに増分されます。

int i = 1;
Map  accountMembers = client.getAccountService()。getSenders(Direction.ASCENDING、new PageRequest(i、5));
		
ながら( !accountMembers .isEmpty()){
(Map.Entry エントリ:accountMembers.entrySet())
	{
		System.out.println(entry.getKey()+ "/" + entry.getValue()。getId());
		i ++;
	}
accountMembers = client.getAccountService()。getSenders(Direction.ASCENDING、new PageRequest(i、5));
}

上記のように、送信者を更新するには送信者IDが必要です。送信者を作成した後は、メールアドレスを更新できないことに注意してください。この場合、新しい送信者を作成する必要があります。

SenderInfo updatedSenderInfo = SenderInfoBuilder.newSenderInfo( "john.smith @example .com ")
                .withName( "ジョン"、"スミス")
                .withTitle( "CEO")
                .withCompany( "XYZ Bank")
                .build();
 
client.getAccountService()。updateSender(updatedSenderInfo、"{senderId}");

同様に、送信者を削除するには送信者IDも必要です。送信者の受信トレイまたはドラフトステータスにパッケージがある場合、送信者は削除される代わりにロックされ、パッケージを作成または送信できなくなります。

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

最後に、特定の送信者がアカウントから送信するドキュメントパッケージを作成する方法のサンプルコードを次に示します。

DocumentPackage packageToSend = PackageBuilder.newPackageNamed( "Cleaning Contract Example")
			.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( "ジョン")
					.withLastName( "スミス")
					.withCustomId( "contractor"))
			.withDocument(DocumentBuilder.newDocumentWithName( "Contract.pdf")
					.fromStream(new FileInputStream( "DOC_FILE_PATH")、DocumentType.PDF)
					.enableExtraction())
				.build();

.NET SDK 次に、.NET SDKを続行します。ユーザーをアカウントの送信者として招待するには、 AccountMember オブジェクト。次に、OneSpan Signを呼び出します AccountService 招待状を送信します。新しい送信者がアカウントに参加するように招待されると、デフォルトで非アクティブな状態で追加されます。送信者は、アカウントをアクティブにするためにクリックする必要があるリンクを含むメールを受信します。ステータスを次のように設定すると、確認手順をスキップできますアクティブあなたを構築するとき AccountMember オブジェクト(送信者が既にOneSpan Signアカウントを持っている場合)。

AccountMemberメンバー= AccountMemberBuilder.NewAccountMember( "price9872 @gmail .com ")
				.WithFirstName( "ジョン")
				.WithLastName( "スミス")
				.WithCompany( "ABC Bank")
				.WithTitle( "CEO")
				.WithStatus(SenderStatus.ACTIVE)
				.Build();
		
client.AccountService.InviteUser(member);

OneSpan Signを呼び出して送信者を取得することもできます AccountService 。以下は、すべての送信者を取得する方法のサンプルコードです。これは、OneSpan Signからのページとして、電子メールとIDとともに取得されます。送信者を更新または削除するには、送信者のIDが必要です。以下のコードでは、返される送信者の数 PageRequest 5に設定されます。ページごとに取得できる送信者の最大数は50です。の最初の値 PageRequest (変数 'i')は、返される必要のある送信者のリスト全体の開始点です。この変数は、送信者のリスト全体のどこにいるかを追跡するために送信者をステップスルーするときに増分されます。

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

while(accountMembers.Count!= 0)
{
foreach(accountMembersのKeyValuePair エントリ)
      	{
        		Debug.WriteLine(entry.Key + "/" + entry.Value.Id);
                i ++;
       	}
      	accountMembers = client.AccountService.GetSenders(Direction.ASCENDING、new PageRequest(i、5));
}

上記のように、送信者を更新するには送信者IDが必要です。送信者を作成した後は、メールアドレスを更新できないことに注意してください。この場合、新しい送信者を作成する必要があります。

SenderInfo updatedSenderInfo = SenderInfoBuilder.NewSenderInfo( "john.smith @example .com ")
                .WithName( "ジョン"、"スミス")
                .WithTitle( "CEO")
                .WithCompany( "XYZ Bank")
                .Build();
 
client.AccountService.UpdateSender(updatedSenderInfo、"{senderId}");

同様に、送信者を削除するには送信者IDも必要です。送信者の受信トレイまたはドラフトステータスにパッケージがある場合、送信者は削除される代わりにロックされ、パッケージを作成または送信できなくなります。

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

最後に、特定の送信者がアカウントから送信するドキュメントパッケージを作成する方法のサンプルコードを次に示します。

DocumentPackage packageToSend = PackageBuilder.NewPackageNamed( "Cleaning Contract Example")
                .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( "ジョン")
                        .WithLastName( "スミス")
                        .WithCustomId( "contractor"))
                .WithDocument(DocumentBuilder.NewDocumentNamed( "Contract.pdf")
                        .FromStream(new FileStream( "DOC_FILE_PATH"、FileMode.Open)、DocumentType.PDF)
                        .EnableExtraction())
                .Build();

 

OneSpan Sign開発者コミュニティ

OneSpan Sign開発者コミュニティ

OneSpan Sign開発者コミュニティに参加してください!フォーラム、ブログ、ドキュメント、SDKダウンロードなど。

今日参加します

REST API

最後に、REST APIについて説明します。ユーザーをアカウントの送信者として招待するには、以下のJSONを作成する必要があります。次に、あなたが作る役職へのリクエスト: https://sandbox.onespan.com/api/account/senders 。新しい送信者がアカウントに参加するように招待されると、デフォルトで非アクティブな状態で追加されます。送信者は、アカウントをアクティブにするためにクリックする必要があるリンクを含むメールを受信します。ステータスを次のように設定すると、確認手順をスキップできますアクティブ JSONを作成するとき(送信者が既にOneSpan Signアカウントを持っている場合)。

[code language = "javascript"] {"メール": "john.smith @example .com "、" firstName ":" John "、" lastName ":" Smith "、" company ":" ABC Bank "、" title ":" CEO "、" status ":" ACTIVE "}

送信者を取得することもできます取得するへのリクエスト: https://sandbox.onespan.com/api/account/senders?from=0&to=10 。この例では、最初の10人の送信者を取得することを選択しました。必要に応じてクエリパラメータをカスタマイズできます。利用可能なクエリパラメータの詳細については、ドキュメンテーション

送信者を更新するには、上記のリクエストから取得できる送信者IDが必要です。送信者を作成した後は、メールアドレスを更新できないことに注意してください。この場合、新しい送信者を作成する必要があります。送信者を更新するには、役職に要求する https://sandbox.onespan.com/api/account/senders/{senderId} 次のJSONで:

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

同様に、送信者を削除するには送信者IDも必要です。送信者のパッケージが受信トレイまたは下書きにある場合、送信者は削除される代わりにロックされ、パッケージを作成または送信できなくなります。送信者を削除するには、次のことを行う必要があります削除へのリクエスト: https://sandbox.onespan.com/api/account/senders/{senderId}

最後に、アカウントから特定の送信者が送信するドキュメントパッケージを作成する方法のサンプルJSONを次に示します。

[code language = "javascript"] {"sender":{"email": "john.smith @example .com "}、" documents ":[{" extract ":true、" name ":" Contract "}]、" status ":" DRAFT "、" roles ":[{" id ":" contractor "、" type ":" SENDER "、" signers ":[{" 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 ":"クリーニング契約の例 "}

コードを実行する

これで、コードを実行できます。「UIの送信者」セグメントで説明したように、OneSpan Signアカウントで新しく作成した送信者を表示できるはずです。Javaおよび.NET SDKの場合、送信者の電子メールとIDを出力するコードを含めました。以下は、出力のスクリーンショットです。 

キャプチャー

このブログや、OneSpan Signをアプリケーションに統合することに関するその他の質問がある場合は、開発者コミュニティフォーラムにアクセスしてください。 https://developer.onespan.com 。それは私からです。読んでくれてありがとう!この投稿が役に立った場合は、Facebook、Twitter、またはLinkedInで共有してください。

ハリスハイダリー
ジュニアテクニカルエバンジェリスト
LinkedIn | ツイッター