Documentation Index
Fetch the complete documentation index at: https://developer.box.com/llms.txt
Use this file to discover all available pages before exploring further.
営業担当者が顧客と対面していて、サービスへの加入や購入の確認など、即座に署名が必要になったときに、アプリケーションを使用する場合を考えてみましょう。
この場合、営業担当者はアプリケーションを使用して署名リクエストを作成した後、顧客にデバイスを手渡してドキュメントに署名してもらうことで、すぐに取引を成立させることができます。
Boxウェブアプリを使用して、例えばテンプレートからこの作業を行うことは非常に簡単です。署名者が署名済みドキュメントのコピーを受信できるように署名者 (複数可) のメールアドレスを設定し、対面での署名というフラグを設定します。リクエストを送信するとすぐに、Signのインターフェースが開き、最初の署名者に署名をリクエストし、その後、2番目の署名者、3番目の署名者のように続きます。
アプリケーション内でこれを使用するには、署名者ごとにis_in_personフラグをtrueに設定して署名リクエストを作成する必要があります。
ただし、アプリケーションではSignのインターフェースを署名者に表示する必要があるため、埋め込みURLが返されるようにembed_url_external_user_idを使用してから、ブラウザウィンドウを開くか、iframeを使用して署名インターフェースを表示する必要があります。
対面での署名リクエストの作成
例として、1人の署名者を設定したテンプレートを使用します。
curl --location 'https://api.box.com/2.0/sign_requests' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Le...Cb' \
--data-raw '{
"template_id": "ee9a689e-96b6-4076-92a0-b9b765eb09ca",
"parent_folder": {
"id": "234102987614",
"type": "folder"
},
"signers": [
{
"email": "signer@example.com",
"role": "signer",
"is_in_person": true,
"embed_url_external_user_id": "1234"
}
]
}'
結果は次のとおりです (簡略化されています)。
{
"signers": [
{
"email": "sender@example.com",
"role": "final_copy_reader",
"is_in_person": false,
},
{
"email": "signer@example.com",
"role": "signer",
"is_in_person": true,
"embed_url_external_user_id": "1234",
"embed_url": "https://app.box.com/sign/document/...",
"iframeable_embed_url": "https://app.box.com/embed/sign/document/..."
}
],
"id": "a9159d31-d2fb-4e88-9306-02c00de013d1",
"parent_folder": {
"id": "234102987614",
"type": "folder",
"name": "signed docs"
},
"name": "Simple-PDF (1).pdf",
"type": "sign-request",
"status": "created",
"template_id": "ee9a689e-96b6-4076-92a0-b9b765eb09ca"
}
レスポンスのembed_urlとiframeable_embed_urlに注目してください。埋め込みURLを参照すると、署名インターフェースが表示されます。
署名が完了すると、署名者には署名済みドキュメントのコピーがメールで送信されます。
複数の署名者による対面での署名
署名者にis_in_personというフラグが設定されている限り、リクエストに含まれるすべての署名者に署名インターフェースが繰り返されます。
たとえば、リクエストに2人目の署名者を追加する場合は、次のようになります。
curl --location 'https://api.box.com/2.0/sign_requests' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Le...Cb' \
--data-raw '{
"template_id": "ee9a689e-96b6-4076-92a0-b9b765eb09ca",
"parent_folder": {
"id": "234102987614",
"type": "folder"
},
"signers": [
{
"email": "signer_a@example.com",
"role": "signer",
"is_in_person": true,
"embed_url_external_user_id": "1234"
},
{
"email": "signer_b@example.com",
"role": "signer",
"is_in_person": true
}
]
}'
結果は次のとおりです (簡略化されています)。
{
"signers": [
{
"email": "sender@example.com",
"role": "final_copy_reader",
"is_in_person": false,
},
{
"email": "signer_a@example.com",
"role": "signer",
"is_in_person": true,
"embed_url": "https://app.box.com/sign/document/...",
"iframeable_embed_url": "https://app.box.com/embed/sign/document/..."
},
{
"email": "signer_b@example.com",
"role": "signer",
"is_in_person": true,
"embed_url": null,
"iframeable_embed_url": null
}
],
"id": "d066575f-f22b-42fc-b9e2-701468776475",
"parent_folder": {
"id": "234102987614",
"type": "folder",
"name": "signed docs"
},
"name": "Simple-PDF (3).pdf",
"type": "sign-request",
"status": "created",
"template_id": "ee9a689e-96b6-4076-92a0-b9b765eb09ca"
}
埋め込みURLを参照すると、最初の署名者に署名インターフェースが表示されます。
最初の署名者が署名すると、署名インターフェースは自動的に2番目の署名者に切り替わります。