この記事では、Sign.Plus eSignature APIを使用して署名のために文書を送信するプロセスについて説明します。
これらの手順に従うことで、エンベロープを作成し、文書を追加し、受信者を設定し、署名アノテーションを挿入し、最後に署名のためにエンベロープを送信できます。
前提条件
- APIプランをお持ちのSign.Plusアカウント
- お使いの
Personal Access Token
ステップ1: エンベロープを作成する
エンベロープとは、受信者が署名する文書を格納するコンテナです。
-
POST /v2/envelope エンドポイントにリクエストを送信して、新しいエンベロープを作成します。
{
"name": "私の素晴らしいエンベロープ",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - APIキーを
Authorizationヘッダーに含めます。 -
成功すると、
Envelopeオブジェクトを受け取ります。{ "id": "<string>" ... } -
idをenvelope_idとして保存します。
ステップ2: エンベロープに文書を追加する
-
POST /v2/envelope/{envelope_id}/document エンドポイントを使用して文書を追加します。
-
{envelope_id}を、ステップ1で取得したIDに置き換えます。 - 文書ファイルを
multipart/form-data.としてリクエストボディに含めてPOSTリクエストを送信します。 -
成功すると、レスポンスとして
Documentオブジェクトを受け取ります。{ "id": "<string>" ... } -
idを後で使用するdocument_idとして保存します。
ステップ3: エンベロープの受信者を設定する
-
POST /v2/envelope/{envelope_id}/signing_steps エンドポイントを使用して、受信者を追加します。
-
{envelope_id}をご自身のエンベロープIDに置き換えます。 -
次のJSONボディを含む
POSTリクエストを送信します:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] } -
成功すると、
SigninStepの配列を受け取ります。 -
その配列を参照し、署名フレーム(署名アノテーション)を追加したい受信者の
id名を取得します。このidをrecipient_idとして保存しておきます。
ステップ4: 文書に署名アノテーションを挿入する
署名アノテーションを追加する前に、Sign.Plusプラットフォームで署名を定義済みであることを確認してください。
- POST /v2/envelope/{envelope_id}/annotationエンドポイントを使用して署名アノテーションを追加します。
-
{envelope_id}をご自身のエンベロープIDに置き換えてください。 - 次のJSON本文を含む
POSTリクエストを送信します:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}<recipient_id>と<document_id>を適切な値に置き換えてください。
ステップ5: エンベロープを署名のために送信する
- POST /v2/envelope/{envelope_id}/sendエンドポイントを使用してエンベロープを送信します。
-
{envelope_id}をご自身のエンベロープIDに置き換えてください。 - このエンドポイントに
POSTリクエストを送信します。 - 成功すると、エンベロープが署名のために受信者に送信されます。
結論
これでSign.Plus eSignature APIを使用して文書を署名のために送信することに成功しました。受信者には、文書に署名するためのリンクを含むメール通知が送られます。
このプロセスで使用される各APIエンドポイントの詳細については、APIドキュメントをご覧ください。