This article will walk you through the process of sending a document for signature using the Sign.Plus eSignature API.
これらの手順に従って、エンベロープを作成し、ドキュメントを追加し、受信者を設定し、署名注釈を挿入し、最後にエンベロープを署名に送信します。
前提条件
- A Sign.Plus account with an API Plan
- あなたの
パーソナルアクセストークン
ステップ 1: エンベロープを作成
封筒は、受信者によって署名されるドキュメントのコンテナです。
-
POST /v2/envelope エンドポイントにリクエストを送信し、新しいエンベロープを作成します。
{
"name": "私の素晴らしいエンベロープ",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} -
Authorization
ヘッダーに、API キーを含めます。 -
成功すると、
Envelope
オブジェクトを受け取ります。{ "id": "<string>" ... }
-
id
をenvelope_id
として保存
ステップ 2: ドキュメントを封筒に追加する
-
POST /v2/envelope/{envelope_id}/document エンドポイントを使用してドキュメントを追加します。
-
{envelope_id}
をステップ1で受け取ったIDに置き換えます。 - リクエスト本文のドキュメントファイルを
multipart/form-dataとしてPOST リクエストを送信します。
-
成功すると、応答として
ドキュメント
オブジェクトを受け取ります。{ "id": "<string>" ... }
-
id
をdocument_id
として保存します。
ステップ 3: エンベロープの受信者を設定する
-
POST /v2/envelope/{envelope_id}/signing_step エンドポイントを使用して、受信者を追加します。
-
{envelope_id}
をエンベロープIDに置き換えます。 -
POST
リクエストを以下の JSON ボディで送信します:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] } -
成功すると、
SigninStep
の配列を受け取ります。 -
配列を参照し、署名フレーム(署名注釈)を追加したい受信者の
id
を取ります。 このid
を受信者の
として保存します。
ステップ 4: 署名注釈をドキュメントに挿入する
署名注釈を追加する前に、 Sign.Plus プラットフォーム で署名を定義していることを確認してください。
- POST /v2/envelope/{envelope_id}/annotation エンドポイントを使用して署名注釈を追加します。
-
{envelope_id}
をエンベロープIDに置き換えます。 - Send a
POST
request with the following JSON body:{
"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ドキュメント を参照してください。