DocuSign API: メール通知なしでエンベロープを無効にする方法

DocuSign API とエンベロープ管理の紹介

デジタルドキュメントワークフローが進化し続ける中で、DocuSign の API は、開発者が電子署名機能をビジネスアプリケーションに統合するのに役立つ強力なツールとして際立っています。署名用のドキュメントをカプセル化するエンベロープは、このエコシステムの中心であり、作成から完了までの契約のシームレスな管理を可能にします。ただし、場合によっては、エラーを修正したり、変化するビジネスニーズに対応するために、署名プロセス前または署名プロセス中にエンベロープをキャンセルする必要があります。API ユーザーにとっての重要な課題は、通知の制御、特に受信者を混乱させる可能性のある不要な電子メールアラートを回避することです。この記事では、公式ドキュメントと実際の導入事例を参照しながら、中断を最小限に抑えながら DocuSign API を介してエンベロープをキャンセルするメカニズムについて説明します。

DocuSign または Adobe Sign を使用した電子署名プラットフォームを比較していますか？

eSignGlobal は、グローバルコンプライアンス、透明性のある価格設定、およびより迅速なオンボーディングプロセスを備えた、より柔軟で費用対効果の高い電子署名ソリューションを提供します。

👉 無料トライアルを開始

DocuSign でのエンベロープのキャンセル：コアコンセプト

DocuSign のエンベロープとは？

DocuSign のエンベロープは、1 つ以上のドキュメント、受信者、および署名指示を含む完全なパッケージを表します。API を介して、開発者はこれらのエンベロープをプログラムで作成、送信、および管理できます。エンベロープをキャンセルすると、事実上無効になり、署名などのさらなるアクションはできなくなります。これは、トランザクションが失敗した場合や、ドキュメントを修正する必要がある場合など、ビジネスプロセスで非常に役立ち、不完全または誤ったプロセスが継続するのを防ぎます。

DocuSign の REST API（バージョン 2.1）は、voidEnvelope メソッドを含むエンベロープ操作のエンドポイントを提供します。デフォルトでは、キャンセルはすべての受信者に通知をトリガーし、キャンセルについて電子メールで通知します。これにより透明性が確保されますが、自動化されたシステムや事前通知による内部修正では理想的ではない場合があります。

デフォルトのキャンセルプロセスと通知の動作

DocuSign API を使用してエンベロープをキャンセルするには、通常、/envelopes/{envelopeId}/void エンドポイントに PUT リクエストを発行します。以下は、DocuSign eSignature SDK を使用した Python の基本的な例です。

from docusign_esign import ApiClient, EnvelopesApi

# API クライアントを初期化します
api_client = ApiClient()
api_client.host = 'https://demo.docusign.net/restapi'
api_client.set_default_header('Authorization', 'Bearer YOUR_ACCESS_TOKEN')

envelopes_api = EnvelopesApi(api_client)

# エンベロープをキャンセルします
void_request = {
    'status': 'voided',
    'voidedReason': 'Document needs revision before sending'
}

envelopes_api.update_envelope_status(
    account_id='YOUR_ACCOUNT_ID',
    envelope_id='ENVELOPE_ID',
    envelope=None,  # Not required for void
    void_uri=void_request
)

この標準的なプロセスでは、DocuSign はエンベロープにリストされている受信者に、キャンセルステータスと理由を詳述した電子メール通知を自動的に送信します。これらの電子メールには、キャンセルの理由が含まれており、参照用にエンベロープへのリンクが含まれている場合があります。DocuSign の開発者ガイドによると、これは監査証跡とユーザーの認識を維持し、ESIGN や eIDAS などのコンプライアンス基準に準拠するための予想される動作です。

ただし、CRM 統合やバッチ処理ツールなどの API 駆動型アプリケーションの場合、これらの電子メールを送信すると、受信トレイが乱雑になったり、内部変更が時期尚早に公開されたりする可能性があります。良いニュースは、DocuSign ではこれらの通知を抑制するためのカスタマイズが可能であり、より制御されたエクスペリエンスを実現できることです。

電子メール通知を送信せずにエンベロープをキャンセルする方法

キャンセルプロセス中に電子メール通知を抑制するには、エンベロープまたはアカウントレベルで事前に構成する必要があります。これは、キャンセル API 呼び出し自体に直接的な「no-notify」フラグがないためです。この戦略では、DocuSign の通知設定と受信者の役割を利用して、外部通信を最小限に抑えます。このアプローチは、エンベロープの数が多く、自動化が重要な Business Pro または Advanced API レベルのエンタープライズユーザーにとって特に価値があります。

ステップ 1：エンベロープ通知の優先設定を構成する

エンベロープを作成または送信する前に、API を介して通知ルールを設定します。エンベロープ定義で notification オブジェクトを使用して、ステータス変更（キャンセルを含む）に関する受信者への電子メールを無効にします。Envelopes API の createEnvelope エンドポイントに含めます。

{
  "notification": {
    "reminders": {
      "reminderDelay": 0,
      "reminderOffset": 0,
      "reminderFrequency": "none"
    },
    "expirations": {
      "expireAfter": 0,
      "expireWarn": 0
    },
    "recipientEmailNotification": {
      "emailSubject": "",
      "emailBlurb": "",
      "emailBody": ""
    }
  }
}

recipientEmailNotification ブロックは、空白のままにするか、デフォルト値を抑制するように設定できます。キャンセルの特定の制御については、エンベロープが「ドラフト」ステータス（status: 'sent' = false）で作成されていることを確認し、最初の通知なしでキャンセルできるようにします。ドラフトからキャンセルされると、通知が無効になっている場合、電子メールはトリガーされません。

ステップ 2：ドラフトステータスからキャンセルする

ドラフトモードでエンベロープをキャンセルする（送信前）と、受信者がまだアラートを受け取っていないため、本質的に通知が回避されます。同じ update_envelope_status 呼び出しを使用しますが、ドラフトエンベロープに対して使用します。

# エンベロープをドラフトとして作成します
envelope_definition = {
    'status': 'created',  # ドラフトモード
    'emailSubject': 'Internal Review Document',
    'documents': [...],  # ドキュメント
    'recipients': {
        'signers': [...]  # 定義しますが、まだ通知しません
    },
    'notification': {  # すべてを抑制します
        'recipientEmailNotification': {}
    }
}

envelopes_api.create_envelope(account_id='YOUR_ACCOUNT_ID', envelope_definition=envelope_definition)

# 後で、送信せずにキャンセルします
void_request = {'status': 'voided', 'voidedReason': 'Internal correction'}
envelopes_api.update_envelope_status(account_id='YOUR_ACCOUNT_ID', envelope_id='DRAFT_ENVELOPE_ID', void_uri=void_request)

この方法により、キャンセルプロセス中に電子メールが送信されないことが保証されます。進行中のエンベロープ（送信済み）の場合は、最初に correct API を使用してドラフトに戻し、次にキャンセルします。allowReassign: false と空の通知フィールドを使用して、修正リクエストで通知を抑制します。

ステップ 3：アカウントレベルおよび高度な構成

より広範な制御については、Enhanced または Enterprise プランで利用可能な DocuSign の ID およびアクセス管理 (IAM) 機能を統合します。IAM を使用すると、Connect API の webhook を介してイベント通知をカスタマイズし、キャンセルイベントを電子メールではなくサーバーにルーティングできます。Connect 構成を設定します。

• エンドポイント：/accounts/{accountId}/connect
• envelopeEvents を含めて「voided」ステータスを使用しますが、電子メール配信は除外します。

さらに、API プラン（Starter は年間 600 ドル、Advanced は年間 5,760 ドル）の場合、webhook を利用してキャンセルをサイレントに処理します。connect リスナーを監視してキャンセルイベントを取得し、DocuSign のデフォルトの電子メールをトリガーせずに内部的に応答します。

ベストプラクティスと制限事項

• テスト：本番環境でのキャンセルは元に戻せないため、DocuSign のデモ環境を使用してプロセスを検証します。
• コンプライアンス：通知の抑制は内部キャンセルでは実行可能ですが、監査ログが規制要件を満たすために理由をキャプチャしていることを確認します。
• クォータ：API プランではエンベロープの数が制限されているため（たとえば、Intermediate では月あたり 100 個）、効率的なキャンセルはクォータの保持に役立ちます。
• エッジケース：エンベロープが部分的に署名されている場合、事前に構成されていない限り、キャンセルはそれらの署名者に通知する可能性があります。

この手法は API 統合を簡素化し、大量のシナリオでの運用ノイズを低減します。ビジネスの観点から見ると、CRM または ERP システムに DocuSign API を使用しているチームの効率が向上しますが、事前の計画が必要です。

競争環境：電子署名プラットフォームの概要

DocuSign は、コア署名用の eSignature やエンドツーエンドの契約処理用の CLM（契約ライフサイクル管理）など、包括的な API スイートで電子署名市場をリードしています。CLM は、AI 駆動型の洞察、テンプレート管理、および分析を統合しており、複雑な契約を管理する企業に最適です。価格は Personal の月額 10 ドルから始まりますが、API 集中型の使用の場合はカスタム Enterprise に拡張され、認証などの追加機能には従量課金コストがかかります。

Adobe Sign（現在は Adobe Acrobat Sign）は、Adobe のドキュメントエコシステムを補完し、強力な PDF 統合とモバイル署名を備えています。自動化のための API アクセスを提供し、同様の REST エンドポイントを介したキャンセルをサポートしますが、Adobe 独自の通知制御があります。プランは Individual の月額 10 ドル/ユーザーから Enterprise の月額 40 ドル/ユーザーまでで、Creative Cloud ツールとのシームレスなワークフローを重視しています。ただし、大量のユーザーの場合、API クォータは高度なアップグレードなしでは制限される可能性があります。

eSignGlobal は、100 の主要な国と地域でコンプライアンスを遵守するグローバルな競争相手として位置付けられており、特にアジア太平洋地域 (APAC) で優位性があります。APAC の電子署名環境は、米国/EU の ESIGN/eIDAS フレームワーク標準とは対照的に、断片化され、高水準で、厳格な規制が特徴です。APAC では、ソリューションには、政府から企業 (G2B) のデジタル ID との深いハードウェア/API レベルのドッキングを含む「エコシステム統合」アプローチが必要です。これは、西洋で一般的な電子メールまたは自己申告ベースの方法の技術的な障壁をはるかに超えています。eSignGlobal は、香港の iAM Smart やシンガポールの Singpass とシームレスに統合して強力な検証を実現することで、これに優れています。Essential プランは月額 16.6 ドルで、最大 100 件のドキュメントの送信、無制限のユーザーシート、およびアクセスコード検証を許可し、コンプライアンスに基づいて強力な価値を提供しながら、競合他社よりも価格が低くなっています。このプラットフォームは、DocuSign および Adobe Sign の実行可能な代替手段として、米国および EU を含むグローバル市場で積極的に拡大しています。

DocuSign よりもスマートな代替案をお探しですか？

eSignGlobal は、グローバルコンプライアンス、透明性のある価格設定、およびより迅速なオンボーディングプロセスを備えた、より柔軟で費用対効果の高い電子署名ソリューションを提供します。

👉 無料トライアルを開始

HelloSign（現在は Dropbox Sign）はシンプルさに重点を置いており、カスタム設定で通知の抑制を許可するキャンセルオプションを含む、エンベロープ管理用の直感的な API を備えています。SMB に適しており、プランは無料（制限付き）から月額 20 ドル/ユーザー（Essentials）までですが、高度な IAM などのエンタープライズレベルの機能が不足しています。

この比較は、トレードオフを強調しています。DocuSign は深さで優れており、eSignGlobal のような代替案は地域の利点を提供します。

電子署名の実装における地域のニュアンス

DocuSign API はグローバルにアクセスできますが、地域差が採用に影響を与える可能性があります。APAC では、前述のように、より厳格なデータ常駐と認証ルールにより、ローカライズされたソリューションの必要性が高まっています。企業は、キャンセルプロセスが法的完全性を維持するように、現地の法律に基づいて API の動作を評価する必要があります。

要するに、通知なしのキャンセルを実現するために DocuSign の API を習得すると、効率的なワークフローが実現します。代替案を探している人にとって、eSignGlobal はニュートラルで地域に準拠したオプションとして検討する価値があり、特に APAC 志向の操作に適しています。