既存のテンプレートからドキュメントを送信する方法

この記事では、Sign.Plus eSignature APIでテンプレートを使用して署名用のドキュメントを送信する手順について説明します。

これらの手順に従うことで、テンプレートからエンベロープを作成し、受信者の詳細を設定して、署名のためにエンベロープを送信できます。

前提条件

• APIプランを含むSign.Plusアカウント
• お客様のPersonal Access Token
• Sign.Plusアカウント内の既存のテンプレート 

ステップ1：テンプレートからエンベロープを作成する

1. テンプレートから新しいエンベロープを作成するには、POST /v2/envelope/from_template/{template_id} エンドポイントを使用します。
2. {template_id} を既存のテンプレートのIDに置き換えます。
   テンプレートIDはどこで確認できますか？
   • https://app.sign.plus/templates にアクセスします。
     
   • 目的のテンプレート名をクリックします。
     
   • 右側のサイドバーからIDをコピーします。
3. 以下のJSONボディを付けて、POST /v2/envelope/from_template/{template_id} にPOSTリクエストを送信します:
   {
"name": "My wonderful envelope from template"
}
4. APIキーをAuthorization ヘッダーに含めます。
5. 成功すると、an Envelopeオブジェクトを受け取ります。{
"id": "66eb7d0467d2d549b89fcb6d",
// ...
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"uid": null,
"name": "",
"email": "",
"role": "SIGNER",
"verification": null
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"uid": null,
"name": "",
"email": "",
"role": "RECEIVES_COPY",
"verification": null
},
{
"id": "66eb7d0467d2d549b89fcb72",
"uid": null,
"name": "",
"email": "",
"role": "SIGNER",
"verification": null
}
]
}
],
"documents": [
// ...
],
"notification": {
// ...
}
}
6. 返されたidをenvelope_idとして今後のAPI呼び出しのために保存します。
7. 署名プロセスで後で使用するために、各受信者のidを記録します。
   例:
   • 66eb7d0467d2d549b89fcb71: 最初のSIGNER （ステップ1）
   • 66eb7d0467d2d549b89fcb71: RECEIVES_A_COPY （ステップ1）
   • 66eb7d0467d2d549b89fcb72: 2番目のSIGNER （ステップ2）

ステップ2：受信者の詳細を設定する

テンプレートに固定の受信者が設定されておらず、受信者の詳細を設定または更新する必要がある場合は、以下の手順に従ってください：

1. POST /v2/envelope/{envelope_id}/signing_steps エンドポイントを使用して、受信者情報を更新します。
2. {envelope_id} を、ステップ1で受け取ったIDに置き換えます。
3. 次のJSONボディを含む POST リクエストを送信します：
   {
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"name": "John Doe",
"email": "john.doe@example.com",
"role": "SIGNER"
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"name": "Mark Twain",
"email": "m.twain@example.com",
"role": "RECEIVES_COPY"
},
{
"id": "66eb7d0467d2d549b89fcb72",
"name": "Jane Smith",
"email": "j.smith@example.com",
"role": "SIGNER"
}
]
}
]
}
4. 成功すると、SigningStepオブジェクトの配列を受け取ります。

ステップ3：署名用にエンベロープを送信する

1. POST /v2/envelope/{envelope_id}/send エンドポイントを使用して、エンベロープを送信します。
2. {envelope_id} を、ステップ1のエンベロープIDに置き換えます。
3. このエンドポイントに POST リクエストを送信します。
4. 成功すると、エンベロープが署名のために受信者に送信されます。

まとめ

これで、Sign.Plus eSignature APIを使用してテンプレートから署名用のドキュメントを送信できました。受信者は、ドキュメントに署名するためのリンクが記載されたメール通知を受け取ります。

テンプレートを使用すると、特にレイアウトや署名要件が一貫している頻繁に使用するドキュメントについて、ドキュメントの署名ワークフローを大幅に効率化できます。