Box Signリクエストを作成する
Box Signリクエストオブジェクトを作成します。
true3、8、13、18日目にドキュメントに署名するよう署名者に促します。リマインダは未署名の署名者にのみ送信されます。
truetrue(テキストの) 入力で生成された署名の使用を無効にします。
20730作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。
https://declined-redirect.com署名者がドキュメントへの署名を拒否した後にリダイレクトされるURI。
Hello! Please sign the document below署名リクエストメールに含 めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。このメッセージには、HTMLタグa、abbr、acronym、b、blockquote、code、em、i、ul、li、ol、strongを含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。
Sign Request from Acme署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィールドを渡さない場合は、デフォルトの件名が使用されます。
123これは、署名リクエストが関連する外部システムのIDを参照する際に使用できます。
Box署名ログで、embed_url_external_idが割り当てられている署名者の横に表示するシステム名 (省略可) として使用されます。
trueUIを使用してドキュメントの準備を完了するために送信者がレスポンスでprepare_urlを受け取る必要があるかどうかを示します。
trueドキュメントを表示する前にテキストメッセージを確認するよう署名者に強制します。この設定を署名者に適用するには、署名者の電話番号を指定する必要があります。
name署名リクエストの名前。
最終的な署名済みドキュメントと署名ログの保存先フォルダ。IDフィールドとtypeフィールドのみが必須です。ルートフォルダ (フォルダID 0) は使用できず、nullにすることもできません。
署名リクエストの作成時にこの値が渡されない場合は、デフォルトのフォルダを使用することになります。デフォルトのフォルダは、ペイロードの最初のソースファイルの親フォルダ (そのフォルダへのアップロード権限がある 場合) または「My Sign Requests」という名前のフォルダになります。
署名に関連するタグがドキュメントのコンテンツに含まれている場合、このprefill_tagsを使用してタグを事前入力できます。その際、タグの「id」を事前入力タグのexternal_idフィールドとして参照します。
trueチェックボックスの事前入力値
2021-04-26日付の事前入力値
1234これは、署名リクエストのファイルに含まれている特定のタグのIDを参照します。
textテキストの事前入力値
https://www.example.com指定した場合、ドキュメントに署名された時点で、署名リクエストがこのURLにリダイレクトされます。
blue署名に特定の色 (青、黒、または赤) を強制します。
次の値のいずれか1つ: blue,black,red
https://declined-example.com署名者がドキュメントへの署名を拒否した後にリダイレクトされるURL。このURLを定義すると、特定の署名者で、デフォルトまたはグローバルのリダイレクトURL設定より優先されます。
example@gmail.com署名者のメールアドレス。メールアドレスが含まれるように構成されているテンプレートを使用する場合を除き、署名リクエストを作成する際は署名者のメールアドレスが必須です。
1234埋め込みURLへのアクセス時に認証を担当する、外部アプリケーションの署名者のユーザーID。
true送信者の埋め込みURLと組み合わせて使用されます。送信者が署名すると、その次のin_person署名者にリダイレクトされます。
truetrueに設定した場合、署名者はリクエストに署名する前にBoxアカウントにログインする必要があります。署名者 に既存のアカウントがない場合、署名者は無料のBoxアカウントを作成できます。verification_phone_numberと組み合わせて選択することはできません。
20署名者の順序
SecretPassword123設定した場合、署名者は、このパスワードを入力しないと、ドキュメントに署名できません。このフィールドは書き込み専用です。
https://example.com署名者がドキュメントに署名した後にリダイレクトされるURL。このURLを定義すると、特定の署名者で、デフォルトまたはグローバルのリダイレクトURL設定より優先されます。拒否した場合のリダイレクトURLが指定されていない場合は、このURLが拒否の操作にも使用されます。
signer"signer"署名リクエストに含まれる署名者のロールを定義します。signerはドキュメントに署名し、approverはドキュメントを承認する必要があります。最終的な署名済みドキュメントと署名ログを受け取るのは、final_copy_readerのみです。
次の値のいずれか1つ: signer,approver,final_copy_reader
cd4ff89-8fc1-42cf-8b29-1890dedd26d7設定した場合、同じ値が設定されている署名者は、同じ入力および同じ署名者グループに割り当てられます。署名者グループはBoxグループではありません。これは、署名リクエストに属しているエンティティであり、この署名リクエスト内でのみ使用/アクセスできます。署名者グループには複数の署名者が含まれることが想定されています。指定された値が1人の署名者に対してのみ使用されている場合、この値は無視され、リクエストは、個別の署名者を対象としたものとして処理されます。指定できる値は任意の文字列で、同じグループに属している署名者を判別するためだけに使用できます。成功したレスポンスでは、同じ署名者グループ内の署名者ではなく、生成されたUUID値が示されます。
falsetrueの場合、署名リクエストに関するメールは送信されません
6314578901設定した場合、2要素認証での署名者の認証にこの電話番号が使用されます。認証されると、署名者はドキュメントに署名できるようになります。login_requiredと組み合わせて選択することはできません。
署名するドキュメントの作成元ファイルのリスト。現在は、10ファイルに制限されています。ファイルごとにIDフィールドとtypeフィールドのみが必要です。
123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb署名リクエストがテンプレートから作成された場合、このフィールドはそのテンプレートのIDを示します。
レスポンスの例
{
"are_reminders_enabled": true,
"are_text_signatures_enabled": true,
"days_valid": 2,
"declined_redirect_url": "https://declined-redirect.com",
"email_message": "Hello! Please sign the document below",
"email_subject": "Sign Request from Acme",
"external_id": "123",
"external_system_name": "Box",
"is_document_preparation_needed": true,
"is_phone_verification_required_to_view": true,
"name": "name",
"prefill_tags": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26"
}
],
"redirect_url": "https://www.example.com",
"template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb"
}