ISVエコシステムアプリケーションインターフェースのスコープ説明

1. 概要

本ドキュメントは、エコシステムパートナーの開発者向けに、eSignGlobal アプリケーション認可体系における Scope（権限ドメイン）の説明を提供することを目的としています。アプリケーション認可の設定を行う際、開発者は実際のビジネス機能要件に応じて対応する Scope を申請する必要があります。各 Scope には、当該権限ドメイン内で呼び出しが許可されている OpenAPI のリストが含まれており、プラットフォームは認可された Scope に基づき、アプリケーションのリソース操作権限を厳格に制御します。

基本認証インターフェース

エコシステムアプリケーションがインターフェースを正式に呼び出す前に、まず認可エンドポイントを通じて呼び出し認証情報を取得する必要があります：

インターフェース名	インターフェースパス	インターフェース説明
AccessToken の取得	`POST /esignglobal/v1/oauth2/accessToken`	appid と appsecret から認証用の access_token を取得し、特定のユーザーとして eSignGlobal API にリクエストを行うために使用します。トークンの有効期間は 24 時間です。

現在、eSignGlobal エコシステムで公開されている Scope 権限ドメインは主に以下の通りです：

signature：電子署名コアサービス
stamp：図章管理サービス
comparisons：契約書比較サービス

2. Scope 詳細とAPI一覧

2.1 Scope: `signature` （電子署名サービス）

この Scope は最も基礎的かつ一般的な権限ドメインであり、電子署名業務の中核となるエンドツーエンドのAPIを含みます。この Scope を認可すると、アプリケーションはテンプレート、署名ファイル（添付ファイルを含む）、参加者、およびエンベロープワークフローの管理と処理を行うことができます。

モジュール1：テンプレートサービス

API名	API説明
署名者のテンプレートコントロール詳細を取得	指定された署名者のテンプレートコントロール情報および対応する属性設定を取得
テンプレート詳細を取得	特定のテンプレートの完全な情報を取得します。フィールドおよびファイル構造の詳細を含みます。
テンプレート入力によるファイル生成	指定されたテンプレートに基づいて業務データを埋め込み、PDF形式のファイルを自動的に作成します。
テンプレート一覧の取得	ページネーションまたは特定のフィルター条件に基づき、現在のアカウントで使用可能なテンプレートリストを取得します。
ファイル合成タスクの詳細を取得	非同期タスクIDにより、テンプレートによるファイル生成タスクの最終実行結果を取得する

モジュール2：ファイル管理

インターフェース名	インターフェース説明
ファイルのアップロード	指定したローカルファイルまたは業務フローファイルをプラットフォームにアップロードし、後の署名処理で使用可能にする
キーワードに基づいて座標を取得する	アップロード済みのドキュメントでテキスト検索を行い、キーワードに一致する位置座標情報を返す
ファイルのダウンロード	特定の署名完了済みドキュメント、ソースファイル、またはその他の業務関連ファイルをダウンロードする
署名対象ファイルの追加	事前に正常にアップロードしたファイルを、特定の署名エンベロープまたはワークフローに紐付ける
署名対象ファイルの削除	エンベローププロセスから誤ってアップロードされたファイルや、一時的に署名不要なファイルを削除する
添付ファイルの追加	封筒または署名フローに補足的な説明添付ファイルを追加する
添付ファイルを削除する	封筒または署名フローから指定の添付文書を削除する

モジュール3：参加者管理

インターフェース名	インターフェース説明
署名者を追加する	特定の封筒フローにおいて、署名動作を実行する必要がある署名者を新規追加する
署名者を削除する	特定の封筒フローから無効化された署名者を削除する
CC対象者を追加する	CC対象者役割を追加し、進捗通知のみを受信して署名完了後の最終ファイルを確認可能にする
CC対象者を削除する	特定のCC対象者役割を削除する

モジュール4：封筒管理

インターフェース名	インターフェース説明
封筒のクイック開始	連携プラットフォームがこのインターフェースを使用して封筒を作成し、署名完了後にシステムが終了処理を自動で行う場合、「封筒の終了」を手動で呼び出す必要はありません。
封筒の作成	下書き状態の封筒を作成するために使用され、署名件名や署名者設定などのパラメータ構成をサポートします。
封筒の開始	すべての署名対象ファイルと署名者が正しいことを確認した後、正式に下流へ署名タスクを送信します。
封筒の終了	封筒を手動で終了します。封筒終了前にすべての署名者は署名を完了する必要があります。プロセス終了後、リソースは変更できなくなります。
署名用URLの取得	指定された署名者の専用ショートリンク、または直接読み込み可能な署名ページURLを取得します。
封筒詳細の照会	この封筒の全体情報、関連ファイル、参加者、および現在の処理状態を取得します。
封筒の取り消し	開始者がまだ完全に完了していない署名封筒を自発的に撤回する
署名催促封筒	封筒の署名が完了していない場合、現在署名が必要な未署名の署名者に対して催促リマインダーを送信できます。催促の間隔は30分です。
署名プレビューページのアドレスを取得する	封筒が開かれた後、このAPIを通じて署名プレビューページのアドレスを取得できます。主に連携プラットフォーム内で、封筒の参加者ではないユーザーが署名ファイルおよび進捗状況を確認できる機能を実現するために使用されます。
封筒送信ビューの作成	封筒IDを使用して封筒送信者ビューを作成します。このビューで開始される署名フローでは、開始者の情報はOAuthのAccess Tokenから取得されたユーザー情報で設定されます。

2.2 Scope: `stamp` （図章管理サービス）

このScopeは企業用印鑑または個人名義印の管理権限付与に特化しています。企業の統一図章ライブラリの保守（図章の登録・削除・更新・照会）のみを行い、署名フローの開始に直接介入する必要がない第三者エコシステムに適しています。

API名	API説明
図章リストの照会	対応する図章照会権限を持つAppIDを使用して、図章リソースリストのデータを取得します。
図章の作成	権限を持つAppIDを使用して、アップロード画像のBase64エンコード文字列（PNG形式対応、サイズ18mm〜100mm）によって図章を作成します。
スタンプの編集	作成済みのスタンプの名前や画像などの情報を変更します
スタンプの削除	指定され、もはや業務に関連しないスタンプリソースを完全に削除します

2.3 Scope: `comparisons` （契約書照合サービス）

このScopeはインテリジェント契約法務機能ドメイン専用に使用されます。エコシステムパートナーアプリケーションは、自社の契約審査・法務評価プロセスにおいて、テキストおよびバージョンの照合機能を柔軟に呼び出し、契約改訂前後の差異を迅速に把握することができます。

API名	API説明
契約書照合結果ページの取得	比較差異結果を表示する可視化ページのURLを取得
契約書照合詳細の照会	契約書照合の業務IDを使用して契約書の照合結果を取得します。これには、差異数（追加・削除・変更の数）と、詳細な照合差異内容（明細の特定位置）が含まれます。