DocuSign API：特定のフォルダにあるすべてのテンプレートのリストを取得する方法

DocuSignテンプレートとAPIの紹介

デジタルドキュメント管理が進化し続ける中で、DocuSignは、世界中の企業のワークフローを効率化する、主要な電子署名プラットフォームとして際立っています。テンプレートはDocuSignにおいて重要な役割を果たし、ユーザーがドキュメントを標準化して再利用できるようにすることで、時間を節約し、契約承認やオンボーディングなどのプロセスの一貫性を確保します。DocuSign APIを使用すると、開発者はこれらのタスクをプログラムで自動化でき、電子署名機能をカスタムアプリケーションに簡単に統合できます。この記事では、DocuSign APIを利用して、特定のフォルダからすべてのテンプレートのリストを取得する方法について説明します。これは、企業環境における効率的なテンプレート管理の一般的なニーズです。

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

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

👉 無料トライアルを開始

DocuSignテンプレートの理解

DocuSignテンプレートは、事前定義されたフィールド、署名者ロール、およびワークフローを含む、事前構成されたドキュメントです。これらはDocuSignアカウント内でフォルダに整理され、ユーザーは部門、プロジェクト、またはタイプ別に分類できます。たとえば、人事テンプレートを1つのフォルダに、販売契約を別のフォルダに配置します。この整理は、大量のドキュメントを扱うチームにとって不可欠であり、混乱を防ぎ、迅速なアクセスを容易にします。

ビジネスの観点から見ると、テンプレートはエラーを減らし、署名プロセスを加速できます。たとえば、営業チームは、毎回フィールドを再作成することなく、提案テンプレートを再利用できるため、ブランドの一貫性とコンプライアンスが確保されます。ただし、数百ものテンプレートを持つ大規模なアカウントの場合、フォルダを手動で参照するのは非効率的になる可能性があります。そこで、DocuSign APIが登場し、テンプレートをクエリして一覧表示するためのプログラミングによる方法を提供します。

DocuSign API入門

DocuSign APIを使用するには、開発者はアクティブなDocuSignアカウントとAPIクレデンシャルが必要です。DocuSignは、本番機能をミラーリングするテスト用の無料のサンドボックス環境を提供しています。認証には通常OAuth 2.0が含まれ、DocuSign開発者センターから統合キー（クライアントID）とシークレットを生成できます。

テンプレートのキーエンドポイントは、eSignature APIの/accounts/{accountId}/templatesリソースにあります。アカウントIDが必要であり、/accountsエンドポイントから取得できます。DocuSignのフォルダは一意のフォルダIDで識別され、これらのIDは/foldersエンドポイントを使用して取得できます。この設定により、テンプレートデータへの安全でスケーラブルなアクセスが保証されます。

DocuSignのAPIドキュメントは包括的であり、Java、.NET、PHP、Pythonなどの言語のSDKをサポートしており、統合を簡素化します。企業にとって、これは電子署名をSalesforceなどのCRMシステムまたはカスタムアプリケーションに埋め込むことができることを意味し、ツールを切り替えることなく運用効率を向上させます。

DocuSign APIを使用して特定のフォルダからテンプレートを取得する方法

DocuSign REST APIを使用して特定のフォルダからテンプレートのリストを取得するのは簡単なプロセスです。この機能は、テンプレートオプションを動的に入力したり、フォルダの内容を監査したりする必要があるアプリケーションに特に役立ちます。コアエンドポイントはGET /accounts/{accountId}/folders/{folderId}/templatesであり、指定されたフォルダ内のテンプレートのページ分割されたリストを返します。

前提条件

コードに入る前に、以下を確認してください。

• OAuth 2.0アクセストークンを持っていること。
• アカウントIDとフォルダIDがわかっていること。フォルダIDを取得するには、最初にGET /accounts/{accountId}/foldersを呼び出してすべてのフォルダを一覧表示し、必要なフォルダを識別します（たとえば、名前または共有ステータスで）。
• 権限：APIユーザーはテンプレートの読み取りアクセス権を持っている必要があります。

ステップバイステップの実装

1. 認証してトークンを取得： OAuthフローを使用してアクセストークンを取得します。たとえば、PythonでDocuSign eSignature SDKを使用します。

   import docusign_esign as ds_esign
   
   # APIクライアントを構成
   api_client = ds_esign.ApiClient()
   api_client.host = 'https://demo.docusign.net/restapi'  # テストにはdemoを使用
   api_client.set_default_header('Authorization', 'Bearer ' + access_token)
   

2. フォルダIDを取得： フォルダIDが不明な場合は、フォルダを一覧表示します。

   envelopes_api = ds_esign.EnvelopesApi(api_client)
   folders = envelopes_api.list_folders(account_id)
   # 反復処理して名前でフォルダを検索します。たとえば、folder_id = next(f['folderId'] for f in folders if f['folderName'] == 'My Templates Folder')
   

3. フォルダ内のテンプレートを一覧表示： Templates APIを使用してテンプレートを取得します。

   templates_api = ds_esign.TemplatesApi(api_client)
   template_list = templates_api.list_templates(account_id, folder=folder_id, count=100)  # ページ分割のためにcountを調整
   for template in template_list.envelopes:
       print(f"Template Name: {template.name}, ID: {template.template_id}")
   

   これにより、テンプレート名、ID、共有ステータス、最終変更日などの詳細が返されます。応答はJSON形式で、テンプレートの概要を含むenvelopes配列が含まれています。

4. ページ分割とエラーの処理： フォルダ内のテンプレートが指定された数（デフォルト20、最大100）を超える場合は、start_positionクエリパラメータを使用して後続のページを取得します。一般的なエラーには、401（未承認）または404（フォルダが見つからない）が含まれます。常にエラー処理を含めてください。

   try:
       template_list = templates_api.list_templates(account_id, folder=folder_id)
   except ds_esign.ApiException as e:
       print(f"Error: {e.body}")
   

5. 高度なフィルタリング： search_textなどのクエリパラメータを追加して名前でフィルタリングするか、includeを追加して共有テンプレートを含めます。エンタープライズユーザーの場合、これはWebhooksと適切に統合され、テンプレートが変更されたときのリアルタイム更新に使用されます。

このAPI呼び出しは通常ミリ秒単位で完了するため、ユーザーがフォルダテンプレートのドロップダウンリストから選択するUI駆動型アプリケーションに最適です。企業レポートによると、テンプレートの検出を自動化することで、ドキュメントの準備時間を最大50％節約できます。

使用例

法律事務所がDocuSignをケース管理システムと統合することを想像してください。APIは「Contracts」フォルダからテンプレートを取得し、ケースの種類に基づいて自動的に入力することで、コンプライアンスと速度を確保します。

APIによるテンプレート管理のベストプラクティス

このAPI機能を実装する際は、セキュリティを優先し、JWTまたは承認コード認証を使用してトークンを取得し、定期的にローテーションします。キャッシュを使用してAPI呼び出しを制限し、レート制限を回避します（たとえば、本番環境では1時間あたり1,000回の呼び出し）。スケーラビリティを実現するには、DocuSignのConnect Webhooksを使用して、アプリケーションに新しいテンプレートを通知し、ポーリングを不要にします。

APIダッシュボードを使用して使用状況を監視し、エンベロープの割り当てを追跡します。テンプレートはBusiness Proなどのプランで全体的な制限にカウントされるためです。サンドボックスでテストすると、本番環境の中断を防ぐことができます。

競合他社とのDocuSignの比較

DocuSignは、シームレスなAPI統合とグローバルコンプライアンスを提供する強力な電子署名プラットフォームです。そのテンプレート管理は構造化された環境で優れていますが、価格はユーザーと機能に応じて拡張されます。

Adobe Signは現在Adobe Document Cloudの一部であり、PDF編集などのAdobeエコシステムとの強力な統合を提供します。クリエイティブチームには使いやすいですが、高度なAPIの使用には追加のライセンスが必要になる場合があります。

eSignGlobalは、特にアジア太平洋（APAC）地域において、競争力のある代替手段として際立っています。APACの断片化された規制状況を特に重視して、世界100の主要国のコンプライアンスをサポートしています。米国（ESIGN）またはヨーロッパ（eIDAS）のフレームワークベースの標準とは異なり、電子メール検証または自己申告に依存しており、APACの規制では、エコシステム統合ソリューションが必要です。政府のデジタルID（G2B）との深いハードウェアおよびAPIレベルの統合です。これには、高い基準と厳格な監督が含まれ、技術的な障壁を西洋モデルよりもはるかに高くしています。eSignGlobalはこの分野で優れており、香港のiAM SmartおよびシンガポールのSingpassとのシームレスな統合を提供し、無制限のユーザーと費用対効果の高い価格設定を備えています。そのEssentialプランは月額わずか16.6ドルで、最大100件の電子署名ドキュメント、無制限のユーザーシートの送信を許可し、アクセスコード検証を通じて、コンプライアンスに基づいて高い価値を提供します。これにより、eSignGlobalはDocuSignおよびAdobe Signとグローバルに競争でき、通常は低コストで実現できます。

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

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

👉 無料トライアルを開始

HelloSign（現在はDropbox Sign）はシンプルさに焦点を当てており、直感的なテンプレートと小規模チームに適したAPIアクセスを提供します。基本的なニーズには費用対効果が高いですが、一部のエンタープライズレベルの機能が不足しています。

この表は、中立的なトレードオフを強調しています。DocuSignは規模、Adobeは統合、eSignGlobalは地域の価値、HelloSignは使いやすさを重視しています。

結論

テンプレート管理のためにDocuSignのAPIをナビゲートすると、特に特定のフォルダクエリに関して、生産性が大幅に向上します。代替手段を探している企業にとって、eSignGlobalはAPACおよびより広範な地域で堅牢で地域に準拠したオプションを提供します。