この記事では、 Sign.Plus eSignature API を使用してテンプレートを使用して署名用のドキュメントを送信するプロセスについて説明します。
これらの手順に従って、テンプレートからエンベロープを作成し、受信者の詳細を設定し、署名用のエンベロープを送信します。
前提条件
- A Sign.Plus account with an API Plan
- あなたの
パーソナルアクセストークン
- Sign.Plus アカウントに既存のテンプレート
ステップ 1: テンプレートからエンベロープを作成
- POST /v2/envelope/from_template/{template_id} エンドポイントを使用して、テンプレートから新しいエンベロープを作成します。
-
{template_id}
を既存のテンプレートのIDに置き換えてください。
テンプレートIDはどこにありますか?-
https://app.sign.plus/templates に移動します。
- 目的のテンプレート名をクリックします。
- 右側のサイドバーからIDをコピーします。
-
https://app.sign.plus/templates に移動します。
- POST リクエストを
POST /v2/envelope/from_template/{template_id}
に次の JSON ボディを送ります:{
"name": "My wonce envelope from template"
} -
Authorization
ヘッダーに、API キーを含めます。 - 成功すると、
エンベロープ
オブジェクトを受け取ります。{
"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": {
// ...
}
} - 今後の API 呼び出しのために、返された
id
をenvelope_id
として保存します。 - 後で署名プロセスで使用するために、各受信者の
ID
を記録します。
例:-
66eb7d0467d2d549b89fcb71
: FirstSIGNER
(Step 1) -
66eb7d0467d2d549b89fcb71
:RECEIVES_A_COPY
(ステップ 1) -
66eb7d0467d2d549b89fcb72
: SecondSIGNER
(ステップ2)
-
ステップ 2: 受信者の詳細を設定
テンプレートに固定の受信者がない場合、受信者の詳細を設定または更新する必要があります。
- POST /v2/envelope/{envelope_id}/signing_step エンドポイントを使用して、受信者情報を更新します。
-
{envelope_id}
をステップ1で受け取ったIDに置き換えます。 - Send a
POST
request with the following JSON body:{
"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"
}
]
}
]
} - 成功すると、
SigningStep
オブジェクトの配列を受け取ります。
ステップ 3: 署名用の封筒を送信する
- POST /v2/envelope/{envelope_id}/send エンドポイントを使用して、エンベロープを送信します。
- ステップ1のエンベロープIDに
{envelope_id}
を置き換えます。 - このエンドポイントに
POST
リクエストを送信します。 - 成功すると、エンベロープは署名の受信者に送信されます。
結論
Sign.Plus eSignature API を使用してテンプレートを使用して署名用のドキュメントを正常に送信しました。 受信者は、ドキュメントに署名するためのリンクが記載された電子メール通知を受け取ります。
テンプレートを使用すると、ドキュメント署名ワークフローを大幅に合理化できます。特に、一貫したレイアウトと署名要件を持つ頻繁に使用されるドキュメントの場合。