テンプレートを使用した署名リクエストの作成

Box Signテンプレートは、署名フィールドやイニシャルフィールド、署名者の役割、および任意のメール設定があらかじめ設定されたドキュメントです。テンプレートはBoxウェブアプリで作成および管理します。APIではテンプレートのリストの取得やテンプレートからの署名リクエストの作成はできますが、テンプレートの作成、編集、削除はできません。テンプレートの署名フィールドとイニシャルフィールドは、特定の署名者に割り当てられます。これらのフィールドは必須または任意に設定できます。テンプレートからリクエストを作成する際に、アプリでこれらのフィールドに事前入力できますが、フィールドが割り当てられた署名者は、署名をする際にその値を変更できます。テンプレートの受信者に対して署名者の本人確認を設定することもできます。リクエスト作成時のオプションについては、Box Signリクエストの作成を参照してください。

テンプレートの作成

Box Signで、[署名] を開いて [テンプレート] を選択します。[新しいテンプレート] を選択し、ドキュメントを選択またはアップロードします。

日付、名前、署名など、必要な署名フィールドやイニシャルフィールドを配置し、テンプレートを保存します。

UIの詳細については、Box Signでのテンプレートの作成に関するサポート記事を参照してください。

テンプレートIDの取得

template_idを確認するには、Box Signテンプレートのリストを取得エンドポイントを使用します。

curl -i -X GET "https://api.box.com/2.0/sign_templates" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

レスポンスは、以下の簡略化した例のようになります。スキーマの詳細については、Box Signテンプレートのリストを取得エンドポイントのリファレンスを参照してください。

{
  "entries": [
    {
      "id": "6ae28666-03c4-4ac1-80db-06a90d3b1361",
      "name": "Contract.pdf",
      "parent_folder": {
        "id": "157064745449",
        "type": "folder",
        "name": "My Sign Requests"
      },
      "signers": [
        {
          "email": "",
          "label": "reader",
          "role": "final_copy_reader"
        },
        {
          "email": "",
          "label": "signer1",
          "role": "signer"
        },
        {
          "email": "",
          "label": "signer2",
          "role": "signer",
          "inputs": [
            {
              "document_tag_id": "signer2_full_name",
              "type": "text",
              "content_type": "full_name"
            },
            {
              "document_tag_id": null,
              "type": "signature"
            },
            {
              "document_tag_id": null,
              "type": "date"
            }
          ]
        }
      ]
    }
  ]
}

各入力フィールドやdocument_tag_idなど特定のテンプレートを調べるには、IDを指定してBox Signテンプレートを取得エンドポイントを使用します。

curl -i -X GET "https://api.box.com/2.0/sign_templates/6ae28666-03c4-4ac1-80db-06a90d3b1361" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

署名リクエストの作成

リクエストの作成時に、template_id、parent_folder、および署名者のメールアドレスを渡します。テンプレートがすでにドキュメントを参照している場合、source_filesは不要です。POST本文内の署名者の順序はテンプレート上の順序と同じにしてください。テンプレートエディタで、事前入力する署名フィールドまたはイニシャルフィールドにタグIDを割り当て、そのdocument_tag_idを設定したprefill_tagsを送信します。

{
  "template_id": "6ae28666-03c4-4ac1-80db-06a90d3b1361",
  "parent_folder": {
    "id": "123456789000",
    "type": "folder"
  },
  "signers": [
    {
      "email": "signer1@example.com",
      "role": "signer"
    },
    {
      "email": "signer2@example.com",
      "role": "signer"
    }
  ],
  "prefill_tags": [
    {
      "document_tag_id": "signer1_full_name",
      "text_value": "Ebenezer Scrooge"
    },
    {
      "document_tag_id": "signer2_full_name",
      "text_value": "Bob Cratchit"
    }
  ]
}

curl -i -X POST "https://api.box.com/2.0/sign_requests" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "template_id": "6ae28666-03c4-4ac1-80db-06a90d3b1361",
       "parent_folder": {
         "type": "folder",
         "id": "123456789000"
       },
       "signers": [
         {
           "email": "signer1@example.com",
           "role": "signer"
         },
         {
           "email": "signer2@example.com",
           "role": "signer"
         }
       ],
       "prefill_tags": [
         {
           "document_tag_id": "signer1_full_name",
           "text_value": "Ebenezer Scrooge"
         },
         {
           "document_tag_id": "signer2_full_name",
           "text_value": "Bob Cratchit"
         }
       ]
     }'

レスポンスには、新しいリクエストのid、template_id、および事前入力した値が含まれます。テンプレートに署名フィールドやイニシャルフィールドがすでに配置されている場合、ドキュメント準備は不要です。日付フィールドがある場合は、現在の日付が入力されます。署名者は自分に割り当てられたフィールドの値を変更できます。

ドキュメントに署名タグやイニシャルタグがすでに含まれていて、ウェブアプリでテンプレートを管理しない場合は、構造化されたドキュメントへの署名を参照してください。

はじめに

アプリケーションと統合

IDとアクセス

APIの利用

トラブルシューティング

コンテンツ

コラボレーション

メタデータと検索

イベントとWebhook

ユーザー

インテリジェントなワークフロー

電子サイン

セキュリティとコンプライアンス

テンプレートを使用した署名リクエストの作成

テンプレートの作成

テンプレートIDの取得

署名リクエストの作成

​テンプレートの作成

​テンプレートIDの取得

​署名リクエストの作成

テンプレートの作成

テンプレートIDの取得

署名リクエストの作成