マニュアル キャンセル

Adobe Acrobat Sign API - FAQ

 

Adobe Acrobat Sign ガイド

新機能

  1. プレリリースノート
  2. リリースノート
  3. 重要な通知

開始する

  1. 管理者向けクイックスタートガイド
  2. ユーザー向けクイックスタートガイド
  3. 開発者向け
  4. ビデオチュートリアルライブラリ
  5. FAQ

管理者

  1. Admin Console の概要
  2. ユーザー管理
    1. ユーザーの追加
      1. ユーザーを追加
      2. ユーザーを一括で追加
      3. ディレクトリからユーザーを追加
      4. MS Azure Active Directory からのユーザーの追加
    2. 機能重視のユーザーの作成
      1. テクニカルアカウント – API ドリブン
      2. サービスアカウント – 手動
    3. プロビジョニングエラーが発生しているユーザーの確認
    4. 名前/メールアドレスの変更
    5. ユーザーのグループメンバーシップの編集
    6. グループインターフェイスを使用したユーザーのグループメンバーシップの編集
    7. ユーザーの管理者役割への昇格
    8. ユーザー ID タイプと SSO
    9. ユーザー ID の切り替え
    10. MS Azure を使用したユーザー認証
    11. Google フェデレーションを使用したユーザー認証
    12. 製品プロファイル
    13. ログインエクスペリエンス
  3. アカウント/グループ設定
    1. 設定の概要
    2. グローバル設定
      1. アカウントレベルと ID
      2. 新しい受信者エクスペリエンス
      3. 自己署名ワークフロー
      4. 一括送信
      5. Web フォーム
      6. カスタム送信ワークフロー
      7. Power Automate ワークフロー
      8. ライブラリ文書
      9. 契約書からフォームデータを収集する
      10. 文書の表示制限
      11. 署名済み契約書の PDF コピーの添付
      12. 電子メールへのリンクの追加
      13. 電子メールへの画像の添付
      14. メールに添付されるファイルの名前
      15. 文書への監査レポートの添付
      16. 複数の文書を 1 つに結合
      17. 個別文書をダウンロード
      18. 署名済み文書をアップロード
      19. アカウント内のユーザーの委任
      20. 外部受信者による委任の許可
      21. 署名の権限
      22. 送信の権限
      23. e シールを追加する権限
      24. デフォルトのタイムゾーンの設定
      25. デフォルトの日付形式の設定
      26. ユーザーの複数グループ所属(UMG)
        1. アップグレードして UMG を使用
      27. グループ管理者の権限
      28. 受信者を置き換え
      29. 監査レポート
        1. 概要
        2. トランザクション確認ページでの未承認アクセスの許可
        3. リマインダーの追加
        4. 表示イベントの追加
        5. 契約書ページ/添付ファイル数の追加
      30. トランザクションフッター
      31. 製品内メッセージとガイダンス
      32. PDF のアクセシビリティ
      33. 新しいオーサリング機能
      34. 医療機関のお客様
    3. アカウント設定
      1. ロゴを追加
      2. 会社のホスト名/URL のカスタマイズ
      3. 会社名を追加
      4. 契約書完了後の URL リダイレクト
    4. 署名の環境設定
      1. 正式に書式設定された署名
      2. 受信者による署名の許可
      3. 署名者による名前の変更
      4. 受信者が保存した署名を使用するのを許可
      5. カスタムの利用条件と消費者への情報開示
      6. フォームフィールド間の受信者の移動
      7. 契約書ワークフローをやり直し
      8. 署名を辞退
      9. 印鑑ワークフローを許可
      10. 署名者による役職または会社名の入力を必須とする
      11. 署名者が手書き署名を印刷および配置するのを許可
      12. 電子サイン時のメッセージの表示
      13. 署名の作成時にモバイルデバイスの使用を必須とする
      14. 署名者から IP アドレスを要求
      15. 参加スタンプから会社名と役職を除外
    5. デジタル署名
      1. 概要
      2. ダウンロードして Acrobat で署名
      3. クラウド署名で署名
      4. ID プロバイダーのメタデータを含める
      5. 制限付きクラウド署名プロバイダー
    6. e シール
    7. デジタル ID
      1. デジタル ID ゲートウェイ
      2. ID チェックポリシー
    8. レポート設定
      1. 新しいレポートエクスペリエンス
      2. 従来のレポート設定
    9. セキュリティ設定
      1. シングルサインオン設定
      2. アカウント記憶設定
      3. ログインパスワードポリシー
      4. ログインパスワードの強さ
      5. Web セッション期間
      6. PDF 暗号化のタイプ
      7. API
      8. ユーザーおよびグループ情報へのアクセス
      9. 許可する IP 範囲
      10. アカウント共有
      11. アカウント共有権限
      12. 契約書の共有制御
      13. 署名者の ID 確認
      14. 契約書の署名パスワード
      15. 文書のパスワード強度
      16. 地理的な場所で署名者をブロック
      17. 電話認証
      18. ナレッジベース認証(KBA)
      19. ページの抽出を許可
      20. 文書リンクの有効期限
      21. Webhook/コールバック用のクライアント証明書のアップロード
      22. タイムスタンプ
    10. 送信設定
      1. ログイン後に送信ページを表示
      2. 送信時に受信名を必須とする
      3. 既知のユーザーの名前値をロック
      4. 受信者の役割を許可
      5. 証人署名者を許可
      6. 受信者グループ
      7. CC 関係者
      8. 受信者の契約書のアクセス
      9. 必須フィールド
      10. 文書の添付
      11. フィールドのフラット化
      12. 契約書を変更
      13. 契約書名
      14. 言語
      15. プライベートメッセージ
      16. 許可されている署名タイプ
      17. リマインダー
      18. 署名済み文書のパスワード保護
      19. 契約書通知の送信方法
      20. 署名者 ID オプション
        1. 概要
        2. 署名パスワード
        3. 電子メールによるワンタイムパスワード
        4. Acrobat Sign 認証
        5. 電話認証
        6. クラウドベースのデジタル署名
        7. ナレッジベース認証
        8. Government ID
        9. 署名者の ID レポート
      21. コンテンツ保護
      22. Notarize トランザクションを有効にする
      23. 文書の有効期限
      24. プレビュー、署名の位置指定、フィールドの追加
      25. 署名順序
      26. Liquid Mode
      27. カスタムのワークフロー制御
      28. 電子サインページのアップロードオプション
      29. 署名後の確認 URL リダイレクト
    11. メッセージテンプレート
    12. バイオ医薬業界標準対応
      1. 概要
      2. ID 認証を強制
      3. 署名の理由
    13. ワークフロー統合
    14. 公証設定
    15. 支払いの統合
    16. 署名者へのメッセージ
    17. SAML 設定
      1. SAML 設定
      2. Microsoft Active Directoryフェデレーションサービスのインストール
      3. Okta のインストール
      4. OneLogin のインストール
      5. Oracle ID フェデレーションのインストール
    18. データガバナンス
    19. タイムスタンプ設定
    20. 外部アーカイブ
    21. アカウントの言語
    22. 電子メール設定
      1. 電子メールのヘッダー/フッター画像
      2. 個々のユーザーの電子メールフッターの許可
      3. 署名依頼電子メールのカスタマイズ
      4. 宛先と CC のフィールドのカスタマイズ
      5. リンクなし通知を有効にする
      6. 電子メールテンプレートのカスタマイズ
    23. echosign.com から adobesign.com への移行
    24. 受信者のオプションの設定
  4. 規制要件に関するガイダンス
    1. アクセシビリティ
      1. アクセシビリティの準拠
      2. Acrobat デスクトップ版を使用したアクセシブルなフォームの作成
      3. アクセシブルな AcroForm の作成
    2. HIPAA
    3. GDPR
      1. GDPR の概要
      2. ユーザーを墨消し
      3. ユーザーの契約書を墨消し
    4. 21 CFR part 11 および EudraLex Annex 11
      1. 21 CRF part 11 検証パック
      2. 21 CFR および EudraLex Annex 11 ハンドブック
      3. 共有責任の分析
    5. 医療機関のお客様
    6. IVES サポート
    7. 契約書の「Vault」への追加
    8. EU/英国に関する考慮事項
      1. EU/英国の国境を超えたトランザクションおよび eIDAS
      2. 電子サインされた証書の HMLR 要件
      3. 英国の電子サイン法に対する Brexit の影響
  5. 契約書の一括ダウンロード
  6. ドメインの要求
  7. 「不正を報告」リンク

契約書の送信、署名、および管理

  1. 受信者オプション
    1. 電子メールリマインダーのキャンセル
    2. 電子サインページのオプション
      1. 電子サインページの概要
      2. フィールドなしで契約書を開いて読む
      3. 契約書への署名を辞退
      4. 署名権限を委任
      5. 契約書を再開
      6. 契約書の PDF をダウンロード
      7. 契約書履歴を表示
      8. 契約書メッセージを表示
      9. 電子サインから手書き署名への変換
      10. 手書き署名から電子サインへの変換 
      11. フォームフィールドを移動
      12. フォームフィールドからのデータの消去
      13. 電子サインのページの拡大と移動
      14. 契約書のツールと情報で使用される言語の変更
      15. 法律上の注意の確認
      16. Acrobat Sign の Cookie の環境設定の調整
  2. 契約書の送信
    1. 送信ページの概要
    2. 自分のみに契約書を送付
    3. 契約書を他のユーザーに送信
    4. 手書き署名
    5. 受信者の署名順序
    6. 一括送信
      1. 一括送信機能の概要
      2. 一括送信 - 親テンプレートを設定
      3. 一括送信 - CSV ファイルを設定
      4. 一括送信トランザクションのキャンセル
      5. 一括送信にリマインダーを追加
      6. 一括送信のレポート機能
  3. 文書へのフィールドの作成
    1. アプリ内オーサリング環境
      1. 自動フィールド検出
      2. オーサリング環境を使用したフィールドのドラッグ&ドロップ
      3. フォームフィールドの受信者への割り当て
      4. 事前入力の役割
      5. 再利用可能なフィールドテンプレートを使用したフィールドの適用
      6. 新しいライブラリテンプレートへのフィールドの転送
      7. 契約書送信時のオーサリング環境の更新
    2. テキストタグを含むフォームの作成
    3. Acrobat(AcroForm)を使用したフォームの作成
      1. AcroForm の作成
      2. アクセシブルな PDF の作成
    4. フィールド
      1. フィールドタイプ
        1. 一般的なフィールドタイプ
        2. インライン画像
        3. 印鑑の画像
      2. フィールドコンテンツの外観
      3. フィールドの検証
      4. マスクされたフィールド値
      5. 表示条件/非表示条件の設定
      6. 計算フィールド
    5. オーサリングに関するよくある質問
  4. 契約書に署名
    1. 受信した契約書への署名
    2. 入力と署名
    3. 自己署名
  5. 契約書を管理
    1. 管理ページの概要
    2. 契約書を委任
    3. 受信者の置換
    4. 文書の表示制限
    5. 契約書のキャンセル
    6. リマインダーの新規作成
    7. リマインダーの確認
    8. リマインダーをキャンセルする場合
    9. Power Automate のフローにアクセス
    10. その他のアクション...
      1. 検索の仕組み
      2. 契約書の表示
      3. 契約書からのテンプレートの作成
      4. 契約書の非表示/再表示
      5. 署名済み契約書をアップロード
      6. 送信済み契約書のファイルとフィールドの変更
      7. 受信者の認証方法の編集
      8. 有効期限の追加または変更
      9. 契約書へのメモの追加
      10. 各契約書の共有
      11. 契約書の共有解除
      12. 各契約書のダウンロード
      13. 契約書の各ファイルのダウンロード
      14. 契約書の監査レポートのダウンロード
      15. 契約書のフィールドコンテンツのダウンロード
  6. 監査レポート
  7. レポートとデータの書き出し
    1. 概要
    2. レポートへのアクセス権をユーザーに付与
    3. レポートチャート
      1. 新規レポートを作成
      2. 契約書レポート
      3. トランザクションレポート
      4. 設定アクティビティレポート
      5. レポートの編集
    4. データの書き出し
      1. 新しいデータ書き出しの作成
      2. Web フォームデータの書き出し
      3. 書き出したデータの編集
      4. データの書き出しコンテンツの更新
      5. 書き出したデータのダウンロード
    5. レポート/書き出したデータの名前変更
    6. レポート/書き出したデータの複製
    7. レポート/書き出したデータのスケジュール
    8. レポート/書き出したデータの削除
    9. トランザクションの使用状況の確認

高度な契約書機能とワークフロー

  1. Web フォーム
    1. Web フォームを作成
    2. Web フォームを編集
    3. Web フォームを無効/有効にする
    4. Web フォームの非表示/再表示を切り替える
    5. URL またはスクリプトコードの検索
    6. URL パラメーターを使用した web フォームフィールドの事前入力
    7. Web フォームを保存して後で完了
    8. Web フォームのサイズ変更
  2. 再利用可能なテンプレート(ライブラリテンプレート)
    1. Acrobat Sign ライブラリの米国政府のフォーム
    2. ライブラリテンプレートの作成
    3. ライブラリテンプレートの名前変更
    4. ライブラリテンプレートのタイプの変更
    5. ライブラリテンプレートの権限レベルの変更
    6. 共有テンプレートのコピー、編集、保存
    7. ライブラリテンプレートの集計フィールドデータのダウンロード
  3. Web フォームおよびライブラリテンプレートの所有権の譲渡
  4. Power Automate ワークフロー
    1. Power Automate 統合の概要と含まれる使用権限
    2. Power Automate 統合を有効にする
    3. 管理ページのインコンテキストアクション
    4. Power Automate の使用状況を追跡
    5. 新しいフローの作成(例)
    6. フローに使用するトリガー
    7. Acrobat Sign 外部からのフローの読み込み
    8. フローの管理
    9. フローの編集
    10. フローの共有
    11. フローを無効または有効にする
    12. フローの削除
    13. 便利なテンプレート
      1. 管理者のみ
        1. 完了したすべての文書の SharePoint への保存
        2. すべての完了した文書の OneDrive for Business への保存
        3. 完了したすべての文書の Google ドライブへの保存
        4. 完了したすべての文書の DropBox への保存
        5. 完了したすべての文書の Box への保存
      2. 契約書のアーカイブ
        1. 完了した文書の SharePoint への保存
        2. 完了した文書の One Drive for Business への保存
        3. 完了した文書の Google ドライブへの保存
        4. 完了した文書の DropBox への保存
        5. 完了した文書の Box への保存
      3. Web フォーム契約書のアーカイブ
        1. 完了した web フォーム文書の SharePoint ライブラリへの保存
        2. 完了した web フォーム文書の OneDrive for Business への保存
        3. 完了した文書の Google ドライブへの保存
        4. 完了した web フォーム文書の Box への保存
      4. 契約書データの抽出
        1. 署名済み文書からのフォームフィールドデータの抽出と Excel シートの更新
      5. 契約書通知
        1. 契約書の内容と署名済み契約書を含むカスタム電子メール通知の送信
        2. Teams チャネルで Adobe Acrobat Sign の通知を受信
        3. Slack で Adobe Acrobat Sign の通知を受信
        4. Webex で Adobe Acrobat Sign の通知を受信
      6. 契約書の生成
        1. Power App フォームと Word テンプレートから文書を生成して署名用に送信
        2. OneDrive の Word テンプレートから契約書を生成して署名を取得
        3. 選択した Excel 行の契約書を生成、レビューおよび署名用に送信
  5. カスタム送信ワークフロー
    1. カスタム送信ワークフローの概要
    2. 新しい送信ワークフローの作成
    3. 送信ワークフローの編集
    4. 送信ワークフローのアクティベートまたはアクティベート解除
    5. 送信ワークフローを使用した契約書の送信
  6. ユーザーと契約書の共有
    1. ユーザーの共有
    2. 契約書の共有

他の製品との統合

  1.  Acrobat Sign 統合の概要
  2. Salesforce 向け Acrobat Sign
  3. Microsoft 向け Acrobat Sign
    1. Microsoft 365 向け Acrobat Sign
    2. Outlook 向け Acrobat Sign
    3. Word/PowerPoint 向け Acrobat Sign
    4. Teams 向け Acrobat Sign
    5. Microsoft PowerApps および Power Automate 向け Acrobat Sign
    6. Acrobat Sign Connector for Microsoft Search
    7. Microsoft Dynamics 向け Acrobat Sign
    8. Microsoft SharePoint 向け Acrobat Sign
  4. その他の統合
    1. ServiceNow 向け Acrobat Sign
    2. HR ServiceNow 向け Acrobat Sign
    3. SAP SuccessFactors 向け Acrobat Sign
    4. Acrobat Sign for Workday
    5. NetSuite 向け Acrobat Sign
    6. VeevaVault 向け Acrobat Sign
    7. Coupa BSM Suite 向け Acrobat Sign
  5. パートナーが管理する統合
  6. 統合キーの取得方法

Acrobat Sign 開発者

  1. REST API
    1. メソッドに関するドキュメント
    2. SDK/開発者ガイド
    3. API に関するよくある質問
  2. Webhooks
    1. Webhook の概要
    2. 新しい webhook の設定
    3. Webhook の表示または編集
    4. Webhook のアクティベート解除または再アクティベート
    5. Webhook の削除
    6. 双方向 SSL 証明書
    7. API の Webhook

サポートとトラブルシューティング

  1. カスタマーサポートリソース
  2. 大規模法人のカスタマーサクセスリソース

API アクセスは、エンタープライズおよび開発者向けのアカウントにのみ提供されます。

コアドキュメントへのリンク

注意:

従来の SOAP API のサポートは、2021 年 5 月に終了しました。

SOAP API を使用しているすべてのお客様は、可能な限り速やかに REST API に移行する必要があります。

ログインしたら、アカウント/Acrobat Sign API/API 情報/REST API およびドキュメント
に進みます。


一般的な概念

Web UI でページを表示してドキュメントを作成したり、ドラッグ&ドロップしたり、または API を介して transientDocumentId を使用して署名者の役割を割り当てたりすることはできません。

transientDocuments 呼び出しは、7 日間有効な transientDocumentID を返します。  これは、以降の API 呼び出しにのみ使用できます。API サーバーに保存され、この ID が割り当てられます。ファイルをアップロードして、以降の API 呼び出しでその ID を参照します。

REST API を使用して Agreement にドキュメントを直接アップロードすることはできません。

REST 要件に従って、最初に一時的なドキュメントを作成してから、Agreement、Widget、または Library メソッドでこの ID をファイルソースとして使用します。

一時的なドキュメントは、Adobe サーバーにアップロードされる PDF、doc、docx などの RAW ソースファイルです。そのため、基本ドキュメントを API サーバーに送信したり、web 上の一時的なドキュメントを送信したりするのに便利です。

はい。API 呼び出し POST /agreements を使用し、v6 でワークフローを使用して契約書を投稿できます。API 呼び出しで workflowId パラメーターを渡します。

ワークフローの workflowId は、GET /workflows 呼び出しを使用して取得できます。

  1. Adobe Acrobat Sign に管理者としてログインします

  2. アカウント/Adobe Acrobat Sign API/API リクエストログに移動します

    API ログ

  1.  Adobe Acrobat Sign アカウントに管理者としてログインします

  2. アカウント/Adobe Acrobat Sign API/API 情報に移動します

  3. REST API サンプルリンクをクリックします

    注意:

    JavaScript SDK をダウンロードするには、https://github.com/adobe-sign/AdobeSignJsSdk を参照してください。

v6 以降、「sendTroughWeb」オプションは使用できなくなりました。stateがそれに取って代わります。 契約書が締結される都道府県です。state フィールドは POST 呼び出しでのみ指定できます。GET /agreements/{ID} で返されることはなく、PUT /agreements/{ID} 呼び出しで提供された場合は無視されます。契約書の最終的なステータスは、GET /agreements/ID から取得できます。

state(string) = ['AUTHORING' or 'DRAFT' or 'IN_PROCESS'].

AUTHORING では、ユーザーは、契約書のドキュメントを送信する前に、作成できます。ここでのオーサリング操作は、フォームフィールドの作成、編集、配置、および契約書のドキュメント内のそれらの構成(受託者、条件、データタイプなど)を指しています。Authoring ステータスのドキュメントを投稿した後、ドキュメントは「Adobe Acrobat Sign の管理」タブの「ドラフト」セクションに表示されます。

DRAFT は、最終的な意図されたリソースの一時的または初期の段階で、最終リソースを作成する手順に従って更新できますが、「Adobe Acrobat Sign の管理」タブの「ドラフト」セクションには表示されません。Draft ステータスを使用すると、参加者が情報を設定する必要はなくなり、後から、PUT /agreements/agreementId を作成してこのドラフトを完了する際に割り当てることができます。 この手順は、契約書を作成するために必要なすべてのデータが得られるまで繰り返し実行できます。

IN_PROCESS は、契約書のステータスを「署名用に送信」に変更し、「Adobe Acrobat Sign の管理」タブの「署名用に送信」セクションに表示します。

sendThroughWeb では、契約書を対話式に送信できます。v5 POST /agreements リクエストの「options」フィールドのさまざまなパラメーターを使用すると、この対話式ビュー(送信ページ)を設定できます。fileUploadOptions などの、これらのページ設定パラメーターはすべて POST agreements/ID/views api に移動されます。

したがって、実際には、POST /agreements API を介して AUTHORING ステータスの契約書を作成することで、sendThroughWeb を実現できます。その後、目的の設定で次のページの URL を確認するには、POST agreements/ID/views API を呼び出します。

以下の手順を実行します。

1. REST API V6 ドキュメントにアクセスして、POST/agreements メソッドを選択します。
2. 次のリクエストコードを使用します。

{

  "fileInfos": [

    {

      "transientDocumentId": "***************************"

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

3. ここで、次のリクエストコードを持つ post /agreements/{agreementId}/views メソッドを使用します。

 

{

  "name": "AUTHORING"

}

応答コードは、オーサリングフィールドの URL を提供します。

コールバック URL は、次の方法で定義できます。

  • 次のパラメーターを使用して、必要に応じてコールバック URL を定義できます:

    "callbackInfo": "",
  • 完全なアカウントのデフォルトのコールバック URL を設定するには、Adobe Acrobat Sign サポートにお問い合わせください。

SOAP UI(SmartBear)は、次のような SSL 接続エラーを取得します。このエラーは、API 呼び出し時に発生します。このエラーは通常、古い SSL、または TLS1.2 より前の TLS プロトコルを使用している場合に発生します

ERROR: Exception in request: javax.net.ssl.SSLException: Received fatal alert: protocol_version
ERROR: An error occurred [Received fatal alert: protocol_version], see error log for details

  1. Bin フォルダーの下の VMOPTIONS ファイルに (-Dsoapui.https.protocols=SSLv3,TLSv1.2) を追加します。

  2. C:\Program Files\SmartBear\SoapUI-5.2.1\bin に移動します(SOAP UI をインストールした場所によって異なります。C:\Program Files (x86) の下にある可能性があります)

  3. VMOPTIONS ファイルで、フル読み取り / 書き込みファイル権限を有効にします。

    VMOPTIONS

  4. VMOPTIONS ファイルを右クリックして、プロパティ/セキュリティタブ/ユーザーの選択の順に選択し、「編集」をクリックします。(「編集」ボタンの上にユーザーアクセス制御アイコンが表示されます)すべてのチェックボックスをオンにして、「OK」をクリックします。

  5. 管理者、システム、およびすべてのアプリケーションパッケージについても同じ手順を繰り返します。

  6. メモ帳を使用してファイルを開きます。

  7. 下部にある「-Dsoapui.https.protocols=SSLv3,TLSv1.2」にこのプロトコルを追加し、変更を保存します。

  8. SOAP UI を閉じて再起動します。API 呼び出し時に SSL エラーが発生することなく動作します。(テスト ping 呼び出しを実行して確認します)。

Adobe Acrobat Sign アプリケーションでクライアント ID とクライアントシークレットを作成するには、次の手順に従います。

  1. Adobe Acrobat Sign アカウントにログインします。

  2. アカウント/Adobe Acrobat Sign API/API アプリケーションに移動します。

    Fnord。

  3. アプリケーションを作成するには、+ アイコンをクリックします。

    Fnord。

  4. 名前と表示名を入力します。

  5. 「ドメイン」で「顧客」を選択し、「保存」をクリックします。

    Fnord。

  6. 1 回クリックして、アプリケーションを強調表示します。

  7. 「アプリケーション向けに OAuth を設定」をクリックします。

    Fnord。

  8. リダイレクト URI を入力します。

  9. 必要なスコープを有効にするには、それぞれのチェックボックスをオンにして、「保存」をクリックします。

  1. アカウント/Adobe Acrobat Sign API/API 情報に移動します。

  2. 統合キーリンクをクリックします。

    統合キーに移動します。

    注意:

    統合キーリンクが表示されない場合は、サクセスマネージャーに連絡してアカウントを有効にしてもらいます。

    • 直観的な値でキーに名前を付けます。
    • アプリケーション機能に必要なさまざまなスコープを選択します。
    • キーを十分に設定したら、「保存」をクリックします。
    「統合キーを作成」インターフェイス

  3. キーは保存されると、アカウント/個人環境設定/アクセストークンに表示されます。

    キーの名前と有効なすべてのスコープが一覧されます。  

    キーの説明を 1 回クリックすると、アクションリンクが現れます。

    • 統合キー - このリンクはリテラルキーを提供します。
    • 無効化 - アクセストークンを無効化し、永久に削除します。
    アクセストークン - 統合キー

  1. Adobe Acrobat Sign アカウントにログインします。

  2. アカウント/Adobe Acrobat Sign API/API アプリケーションに移動します。

  3. + アイコンをクリックしてアプリケーションを作成します。

    Postman1

  4. 「アプリケーション向けに OAuth を設定」をクリックします。

    Fnord。

  5. 次のリンクを使用して認証コードを生成します。クライアント ID、リダイレクト URI、およびスコープは、アプリケーションで選択した次の URL と同じでなければなりません(次の URL ではスペースを避け、「NA1」などのシャードは Adobe Acrobat Sign アカウントの所属先に応じます):https://secure.na1.echosign.com/public/oauth?redirect_uri=https://www.google.co.in&response_type=code&client_id=CBJCHBCAABAAo9FZgq31_5BVG_kcIXEe6gNtn-R-gdNe&scope=user_login:self+agreement_send:account

  6. 呼び出しが成功した場合は、アドレスバーから認証コードを取得します。

    Fnord。

  7. https://www.getpostman.com/apps リンクから Postman をダウンロードしてインストールします。

  8. ダウンロードしてインストールしたら、「新規」をクリックして POST を作成します。

  9. Adobe Acrobat Sign アカウントの所属先に応じて、https://secure.na1.echosign.com/oauth/token リンクを入力します。

  10. 「ヘッダー」で、application/x-www-form-urlencoded としてコンテンツタイプを入力します。

  11. 「本文」で x-www-form-urlencoded が選択されていることを確認し、Adobe Acrobat Sign アカウントで作成したアプリケーションの対応する値を使用して以下のパラメーターを入力し、「送信」をクリックします。

    Fnord。

  12. すべての情報が正しい場合は、応答でアクセストークンとリフレッシュトークンが返されます。

    Fnord。

OAuth プロセスの実行中は、必ず次の点に従ってください。

1. 正しいクライアント ID とリダイレクト URI を指定します。
2. 認証 URL で指定されたスコープは、Adobe Acrobat Sign アプリケーションで指定されたスコープと正確に一致している必要があります。
3. アカウントに設定されているとおりに、正しいシャード(na1、na2、au1、eu1、jp1)を使用します。
4. 認証 URL に指定されているスペースがあれば、それを削除します。
5. 認証 URL の構文を確認します。

https://secure.na1.echosign.com/public/oauth?redirect_uri=https://secure.na1.echosign.com/public/oauthDemo&
response_type=code&client_id=9MEJXY4Y4R7L2T&scope=agreement_send

アクセストークンは、有効期限切れの後 3600 秒(1 時間)のみ有効です。

API リクエスト所有者は、必要に応じて新しいアクセストークンを生成するために、リフレッシュトークンを使用できます。

Webhook は、REST API v6 以降でサポートされています。

Webhook レシーバーが 72 時間以内に応答しない場合、Webhook は無効になり、通知は送信されません。

Webhook のターゲット URL が何らかの理由でダウンしている場合、Adobe Acrobat Sign は JSON をキューに入れ、72 時間にわたるプログレッシブサイクルでプッシュを再試行します。

未配信のイベントは再試行キューに保持され、通知を発生した順序で配信するために、次の 72 時間にわたってベストエフォート型配信が実行されます。

通知配信の再試行戦略では、試行間隔を倍増し、1 分間隔から始めて 12 時間ごとまでに増やします。結果として、72 時間の間に 15 回の再試行が行われます。

 

Adobe Acrobat Sign UI から Webhook を直接作成するには、まず次の手順に従って Azure AD Function アプリを介して Webhook URL を作成します。

  1. Microsoft アカウントで https://portal.azure.com/ にログインします。

  2. AzureAD アカウントで Function Apps に登録します。

    Azure メニュー

  3. AzureAD に移動し、「Function Apps」に移動して、関数の + アイコンをクリックします。

  4. 言語として JavaScript を使用している「webhook + API」を選択し、「関数を作成」をクリックします。

    Azure API UI

  5. Index.js ファイルを次のコードスニペットで置き換えます。

    module.exports = function (context, req) { var clientId = req.headers['x-adobesign-clientid']; // Validate that the incoming ClientID is genuine if (clientId === '************************************') { context.res = { // status: 200, /* Defaults to 200 */ // any 2XX response is acceptable body: { 'xAdobeSignClientId' : clientId, }, headers : { 'Content-Type' : 'application/json' } }; } else { context.res = { status: 400, body: "Opps!! Illegitimate Call identified" }; } context.done(); 
    };
  6. 右隅にある「テスト」ボタンをクリックして、次のヘッダーを入力します。

    X-AdobeSign-ClientId as ***********************

    API テスト

  7. 「保存して実行」をクリックします。

  8. 次のヘッダーの 200 OK 応答を受信したら、「関数 URL を取得」をクリックします。

    200 応答

  9. URL をコピーし、Adobe Acrobat Sign UI/Webhook に移動し、+ アイコンをクリックして Webhook を作成します。

  10. 次の情報を入力します。

    • 名前:他の管理者が簡単に理解できる直観的な名前が推奨されます。
    • スコープ:Webhook がキャッチしているネットの広範さ。アカウントとグループはインターフェイスで使用できます。
      API は、アカウント、グループ、ユーザー、およびリソースのスコープをサポートします。
    • Webhook ごとに 1 つのスコープしか定義できません。
    • URL:Adobe Acrobat Sign が JSON ペイロードをプッシュしたターゲット URL。
    • イベント:Adobe Acrobat Sign による JSON の構築と URL へのプッシュを引き起こしたトリガー。
      各イベントは、トリガーイベントに関連する異なるペイロードを構築します。
      複数のイベントを 1 つの Webhook に含めることができます。
    • 通知パラメーター:通知パラメーターは、イベント JSON ペイロードのセクションを識別し、重要なイベントのセクションのみを選択できるようにします。
    Webhook UI

  11. Webhook が完全に定義された後、「保存」をクリックすると、新しい Webhook がトリガーイベントに即座に反応し始めます。

契約書アセットとは、ライブラリドキュメント、ウィジェット、契約書自体など、それらを介して契約書を作成することができるアセットです。

契約書アセットイベントを検索するには、まず、関連する検索パラメーターを使用して agreementAssetEvents を作成する API にリクエストします。

応答は、結果の最初のページで、検索 ID パラメーターと次のページカーソルが一緒に示されます。API を使用して利用可能な場合は、検索 ID に基づいて agreementAssetEvents を取得することで、さらにページ結果を取得できます。

  1. バージョン 5 の REST API ドキュメントを開きます。

  2. post/search/agreementAssetEvents に移動し、関連するスコープを持つアクセストークンを生成します。

  3. リクエストコードで、要件に従って開始日と終了日を定義します。

    { 
      "endDate": "2018-05-22T22:33:33", "startDate": "2017-12-22T22:33:33" 
    }
  4. 「Try it out」をクリックします。契約書アセット ID を取得します。これは、契約書 ID としても使用できます。


ユーザー/アカウント管理

  1. Adobe Acrobat Sign にログインします。
  2. アカウント/Adobe Acrobat Sign API/REST API ドキュメントに移動します。
  3. 「バージョン 5」を選択します。
  4. post /users メソッドで、
    UserCreationInfo メソッド
    の下に記述されたリクエストコード、{
    "email": "email@email.com",
    "firstName": "AA",
    "lastName": "AB",
    "password":"12******rte"
    } を使用します。

Admin Console(Adobe One)を使用してユーザー権限を管理している Acrobat Sign アカウントは、Adobe Acrobat Sign API を使用して、ユーザーを作成したり、既存のユーザーを管理したりすることはできません。

Adobe One Admin ConsoleAdobe Acrobat Sign API とは異なる API を使用します。自分、グループまたはアカウントのアクセストークンを認証します。

 

グループ ID を取得:

  1. https://secure.na1.echosign.com/public/docs/restapi/v5 に移動します。

  2. 「リソースと操作」でグループをクリックします。

  3. 「GET /groups」をクリックします。

  4. 「oAuth アクセストークン」ボタンをクリックします。

  5. アクセストークンを生成します。

  6. 「Try it out」ボタンをクリックします。

    グループ名とグループ ID を含む次のような応答を受信します。

    { 
      "groupInfoList": [ { "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", "groupName": "Default Group" }, { "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", "groupName": "test" 
        }, 
      ] 
    }

グループを削除:

  1. 「DELETE /groups/{groupId}」をクリックします。

  2. アクセストークンを生成するには、「oAuth アクセストークン」ボタンをクリックします。

  3. 削除するグループの、前の呼び出しの応答で受信した groupId を groupId ボックスに追加します。

  4. 「Try it Out」をクリックします。

    グループが削除されると、「No content」のような応答を受信します。

注意:

ユーザーが割り当てられているグループは削除できません。実際には、空のグループのみを削除できます。グループにユーザーが存在する場合は、次のような応答を受信します。


{

  "code": "GROUP_NOT_EMPTY",

  "message": "The group cannot be deleted because it is not empty."

}


契約書の開始/送信

一時ドキュメントの生成

  1. transientDocuments をクリックし、POST /transientDocuments メソッドを展開します。

  2. OAuth アクセストークンボタンをクリックします。

    API TransientDocument メソッド

    • トランザクションのスコープを有効にします。
    • 認証をクリックします。
    OAuth のスコープ

  3. アクセスを許可

    必要に応じて、アクセスを許可をクリックします。

  4. API メソッドページに戻ります。今度は、Authorization 値が入力されています。

    • File-Name フィールドにファイル名を入力します。
    • ファイルを選択」ボタンをクリックして、契約書のドキュメントをアップロードします。
    • Try it out! 」ボタンをクリックします。
    Try it out!

  5. 応答が生成されます。

    transientDocumentID は、応答の本文に示されています。

    一時的なドキュメント ID

一時的なドキュメントを使用した契約書の生成

  1. 契約書をクリックして、POST /agreements メソッドを展開します。

    • OAuth アクセストークンボタンをクリックします。
    • OAuth のスコープを有効にします。
    • 認証をクリックします。
      • 必要に応じて、アクセスを許可をクリックします。
  2. API メソッドページに戻ります。今度は、Authorization 値が入力されています。

    • 以下のスクリプトをテキストエディターにコピーします(このスクリプトは最小限の設定例であり、本番コードは異なります)。
    •  示されているコードに、trasientDocumentId の値を挿入します。
    { 
      "fileInfos": [ {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} ], "name": "test doc", "participantSetsInfo": [ { "memberInfos": [ { "email": "noreply@echosign.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "DRAFT" 
    }

     

    • カスタムスクリプトをコピーし、AgreementInfo フィールドに貼り付けます。
    • Try it out! 」ボタンをクリックします。
    POST agreement メソッド

  3. 応答が生成されます。

    agreementID は、応答の本文に示されています。

    POST agreement メソッドの応答

FileInfo パラメーターでファイルを追加する手順は、次のとおりです。

  1. 一時 ID を使用:

    POST/transientDocuments に移動し、ローカルシステムから使用するドキュメントをアップロードします。
    POST/Agreements の「ファイル情報」セクションで生成された一時 ID を使用します。

    "fileInfos": [ { "transientDocumentId": "" 
         } 
       ],
  2. ライブラリドキュメント ID を使用:

    ダッシュボードに移動します。「ドキュメントをライブラリに追加」をクリックし、テンプレートを保存します。
    REST API ドキュメントで、GET /libraryDocuments をクリックし、作成しているテンプレートのライブラリ ID を取得します。
    POST/Agreements で、ライブラリドキュメント ID を入力します。

    "libraryDocumentId": "", "libraryDocumentName": "",
  3. 公開されている使用可能な URL を使用:

    FileInfo パラメーターで、使用する公開されたアクセス可能な URL を指定します。

    { 
          "documentURL": { "mimeType": "", "name": "", "url": "" 
          },
  1. 契約書/POST/agreements オプションを選択します。 

  2. 「Oauth アクセストークン」オプションを選択し、必要なスコープを指定します。

  3. アクセストークンが追加されたら、次のリクエストコードを使用できます。

    { 
    "documentCreationInfo": { "recipientSetInfos": [ { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{"email": "testemail@email.com"}] }, { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{"email": "testemail@email.com"}] } ], "signatureFlow": "SEQUENTIAL", "name": "husband wife", "signatureType": "ESIGN", "fileInfos": [ { "transientDocumentId": "(SAMPLE VALUE)3AAABLblqZhAJ9H6e23kZAfBUbItPvIhHTEyA6eZhziEp4KSntYcULpo43OEXwuWiWa-IM1r1EExYW0044CjCkliP4WFL5yKBUDq5DYSmSxVlFypcD0at8kK-BX-Mu3T9c_3GUqgDg0ArX0MmzWT72GLR_0M4Jq--mtuqGzq-VK1s-WGR6GcbedVY7XWAf3b3h-SpE08Hc-iF3zO7jQzi9newXSl-iW2JJsb_55tggkyxkXAkj74C1WD6KkJzgblK0JU-seh6QPDd0Fv6_mfQe2EPQA31nXj50aXwD_xlUBq7mg5FeaBnZ5bzgoqIWGHkbyeD2taaFdw*"} 
    ] 
    } 
    }

POST /agreements 呼び出しでは、signatureflow パラメーターに対して、SENDER_SIGNS_FIRST または SENDER_SIGNS_LAST 値を渡して、それぞれ送信者を最初の署名者または最後の署名者として追加できます。

JSON 形式の呼び出しの例を次に示します。

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

注意:

代理送信のオプションは、高度な共有が有効な REST API V6 でのみ使用可能です。

共有で送信権限が提供されていない場合、または高度な共有が有効でない場合は、次のような応答が表示されます。

 

{"code":"PERMISSION_DENIED","message":"User provided in x-on-behalf-of-user header does not have required permission to perform this operation."}

 

代理送信機能では、アカウントの「高度なアカウント共有」を有効にして、ユーザーがアカウントを共有しながら他のユーザーに送信権限を与えることができるようにします。高度な共有については、「高度なアカウント共有の有効化」を参照してください。

ユーザー共有が有効になったら、次の手順に従って代理送信します。

一時的なドキュメントの生成:

  1. transientDocuments の下で、POST /transientDocuments をクリックします。

  2. 認証用のトークンを生成するには、「OAUTH アクセストークン」ボタンをクリックします。

  3. x-on-behalf-of-user で、代理送信するユーザの電子メールを email:test@email.com 形式で入力します。

  4. ファイルを選択するには、「ファイルを選択」をクリックし、「Try it Out」をクリックします。

    transientDocumentId を持つ次のような応答を受信します。

    {"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}

一時的なドキュメントを使用した契約書の生成:

  1. 契約書の下で、POST /agreements をクリックします。

  2. 認証用のトークンを生成するには、「OAUTH アクセストークン」ボタンをクリックします。

  3. x-on-behalf-of-user で、一時的なドキュメントの作成中に完了するように、ユーザーの電子メールを指定します。

  4. AgreementInfo に次のコードを追加し、「Try it out」をクリックします。

    { 
      "fileInfos": [ { "transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*" } ], "name": "Test", "participantSetsInfo": [ { "memberInfos": [ { "email": "signer@email.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "IN_PROCESS" 
    }

     

    agreementId とともに次のような応答を受信します。

    { 
      
      "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
      
    }
  1. Adobe Acrobat Sign にログインします。

  2. アカウント/Adobe Acrobat Sign API/API 情報に移動し、「REST API メソッドドキュメント」をクリックします。

    Webhook UI

  3. POST /transientDocuments を実行し、ファイルをアップロードして、一時的なドキュメント ID を作成します。

  4. 一時的なドキュメント ID をコピーし、POST /agreements メソッドで使用します。ボックスで次の JSON リクエストをメンションします。

    { 
        "documentCreationInfo": { 
            "mergeFieldInfo": null, 
            "recipientSetInfos": [{ 
                    "signingOrder": null, 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "securityOptions": null, 
                        "email": "test1@gmail.com" 
                    }], 
                    "privateMessage": "Hello 1", 
                    "securityOptions": null 
                }, 
                { 
                    "signingOrder": null, 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "securityOptions": null, 
                        "email": "test2@gmail.com" 
                    }], 
                    "privateMessage": "Hello 2", 
                    "securityOptions": null 
                } 
            ], 
            "signatureType": "ESIGN", 
            "callbackInfo": null, 
            "message": "Please review and sign this document.", 
            "locale": "en_US", 
            "vaultingInfo": null, 
            "securityOptions": null, 
            "reminderFrequency": null, 
            "ccs": null, 
            "postSignOptions": null, 
            "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
            "daysUntilSigningDeadline": null, 
            "formFieldLayerTemplates": [], 
            "name": "Adobe Sign Agreement", 
            "formFields": null, 
            "fileInfos": [{ 
                "libraryDocumentName": null, 
                "transientDocumentId": "XXXXXXXXXXXX", 
                "documentURL": null, 
                "libraryDocumentId": null 
            }] 
        } 
    }
  5. JSON リクエストを実行するには、「Try It Out」ボタンをクリックします。

    Webhook UI

    正しい JSON は、契約書 ID とともに応答を返します。

    Webhook UI

オープンパスワードを設定するためにコードで渡すことができるパラメーターは次のとおりです。

 

{

    "documentCreationInfo":

    [{

        "signatureType": "ESIGN",

               "recipientSetInfos": [{

            "recipientSetMemberInfos": [{                      

                "email": "abc@xyz.com"

            }],

                   

            "recipientSetRole": "SIGNER"

        }],

               "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

                   "fileInfos": [           {               

            "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V"        

        }       ],

               "name": "Open password to view document",

               "securityOptions": {        

            "openPassword": "1234",

                     "protectOpen": true   

        }

    }]

}

 

API を使用してステータスが「AUTHORING」の契約書を作成するには、次の手順を実行します。

Post /agreements に移動し、必要なスコープを持つアクセストークンを作成します。

次のようにリクエストコードを使用します。

 

{

  "fileInfos": [

    {

      "transientDocumentId": "*********************"

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

v6 には、契約書を作成するための一連のオーサリング API があります。v5 では、formFields が POST /agreements API で直接使用されます。ただし、v6 では、ユーザーは v6 POST /agreements を介して AUTHORING ステータスの(state = AUTHORING)の契約書を作成し、後から任意の時点で、PUT /agreements/ID/formFields を使用して、この契約書のドキュメントにフォームフィールドを追加できます。

手順は次のとおりです。

  1. REST API V6 ドキュメントに移動して、POST/agreements メソッドを選択します。

  2. 次のリクエストコードを使用します。

    { 
      "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" 
    }
  3. 次のリクエストをサンプルとして用いて、put /agreements/{agreementId}/formFields メソッドを使用します。

    { 
      "fields": [ { "locations": [ { "height": 36, "left": 75, "pageNumber": "1", "top": 200, "width": 150 } ], "contentType": "SIGNATURE_BLOCK", "name": "sigBlock1", "inputType": "SIGNATURE", "recipientIndex":1 
           } 
    ]}

     

    リクエストが完了すると、指定された受信者に契約書が送信されます。

  1. Adobe Acrobat Sign にログインします。

  2. アカウント/Adobe Acrobat Sign API/API 情報に移動し、「REST API メソッドドキュメント」をクリックします。

    Webhook UI

  3. POST /transientDocuments を実行し、ファイルをアップロードして、一時的なドキュメント ID を作成します。

  4. 一時的なドキュメント ID をコピーし、POST /agreements メソッドで使用します。ボックスで次の JSON リクエストをメンションします。

    { 
        "documentCreationInfo": { "recipientSetInfos": [{ "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test1@gmail.com" }], "privateMessage": "Hello 1" }, { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test2@gmail.com" }], "privateMessage": "Hello 2" } ], "signatureType": "ESIGN", "message": "Please review and sign this document.", "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "name": "Demo1", "fileInfos": [{ "transientDocumentId": "XXXXXXXXXX" }], "formFields": [{ "hidden": "1", "defaultValue": "test1@gmail.com", "name": "Signer Email (Applicant-1)", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 1, "top": 100, "left": 100, "width": 100, "height": 30 }, "contentType": "SIGNER_EMAIL" }, { "name": "Signature (Applicant-2)", "inputType": "SIGNATURE", "locations": { "pageNumber": 1, "top": 520, "left": 162, "width": 280, "height": 30 }, "contentType": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-3)", "inputType": "SIGNATURE", "locations": { "pageNumber": 2, "top": 312, "left": 154, "width": 280, "height": 30 }, "contentType": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "defaultValue": "017/09/2018", "displayFormatType": "DATE", "name": "Signature Date (Applicant-4)", "format": "DATE_DD_MM_YYYY", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 2, "top": 260, "left": 90, "width": 80, "height": 30 }, "contentType": "DATA", "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-5)", "inputType": "SIGNATURE", "locations": { "pageNumber": 3, "top": 199, "left": 179, "width": 276, "height": 30 }, "contentType ": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "contentType": "SIGNATURE_DATE", "defaultValue": "06/07/2018", "displayFormatType": "DATE", "name": "Signature Date (Applicant-6)", "format": "DATE_DD_MM_YYYY", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 3, "top": 188, "left": 488, "width": 76, "height": 25 }, "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-7)", "inputType": "SIGNATURE", "locations": { "pageNumber": 3, "top": 370, "left": 37, "width": 210, "height": 26 }, "contentType ": "SIGNATURE", "required": 1, "recipientIndex": 2 }, { "contentType ": "SIGNATURE_DATE", "defaultValue": "01/02/2018", "name": "Signature Date (Applicant-8)", "locations": { "pageNumber": 3, "top": 370, "left": 300, "width": 76, "height": 26 }, "required": 1, "recipientIndex": 2 
      
                } 
            ] 
        } 
    }
  5. JSON リクエストを実行するには、「Try It Out」ボタンをクリックします。

    Webhook UI

    正しい JSON は、契約書 ID とともに応答を返します。

    Webhook UI

  1. Adobe Acrobat Sign にログインします。

  2. アカウント/Adobe Acrobat Sign API/API 情報に移動し、「REST API メソッドドキュメント」をクリックします。

    Fnord。

  3. POST /transientDocuments を実行し、ファイルをアップロードして、一時的なドキュメント ID を作成します。

  4. 一時的なドキュメント ID をコピーし、POST /agreements メソッドで使用します。ボックスで次の JSON リクエストをメンションします。

    { 
        "options": { 
            "noChrome": true, 
            "authoringRequested": true 
        }, 
        "documentCreationInfo": { 
            "recipientSetInfos": [{ 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test1@gmail.com" 
                    }], 
                    "privateMessage": "Hello 1" 
                }, 
                { 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test2@gmail.com" 
                    }], 
                    "privateMessage": "Hello 44" 
                } 
            ], 
            "signatureType": "ESIGN", 
            "message": "Please review and sign this document.", 
            "locale": "en_US", 
            "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
            "formFieldLayerTemplates": [], 
            "name": "Adobe Sign Agreement", 
            "formFields": null, 
            "fileInfos": [{ 
                "libraryDocumentName": null, 
                "transientDocumentId": "XXXXXXXXXXXX" 
            }] 
        } 
    }
  5. JSON リクエストを実行するには、「Try It Out」ボタンをクリックします。

    Fnord。

    正しい JSON は、契約書 ID とともに応答を返します。

    Fnord。

  6. オーサリングモードで契約書を開くには、URL をコピーしてブラウザーのアドレスバーに貼り付けます。

  7. 必要な場所にフォームフィールドをドラッグ&ドロップします。

  8. 署名用に契約書を送信するには、「送信」をクリックします。 

POST /agreements を使用して、契約書を作成します。署名用に契約書を送信し、クライアントへの応答で agreementID を返します。電話認証メソッドを使用して契約書を送信するための JSON 形式は以下のとおりです。

 

{

"documentCreationInfo": {

"mergeFieldInfo": null,

"recipientSetInfos": [{

"signingOrder": null,

"recipientSetRole": "SIGNER",

"recipientSetMemberInfos": [{

"securityOptions": null,

"email": "Signer@email.com"

}],

 

"privateMessage": null,

"securityOptions": [{

"authenticationMethod": "PHONE",

"phoneInfos": [{

"phone": "1111111111",

"countryCode": "+1"

}]

}]

}],

 

"signatureType": "ESIGN",

"callbackInfo": null,

"message": "Please review and sign this document.",

"locale": "en_US",

"vaultingInfo": null,

"securityOptions": null,

"reminderFrequency": null,

"ccs": null,

"postSignOptions": null,

"signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

"daysUntilSigningDeadline": null,

"formFieldLayerTemplates": [],

"name": "Adobe Sign Agreement-Phone authentication testing",

"formFields": null,

"fileInfos": [{

"libraryDocumentName": null,

"transientDocumentId": "3AAABLYourTransactionID",

"documentURL": null,

"libraryDocumentId": null

}]

},

 

"options": {

"autoLoginUser": true,

"authoringRequested": false,

"noChrome": true,

"sendThroughWeb": null,

"sendThroughWebOptions": null,

"locale": "en_US"

}

}

 

次のメソッドを使用して、データをフォームフィールドに直接結合できます。

  • ライブラリテンプレートの使用:

    FileInfo パラメーターでライブラリテンプレート ID を使用している場合は、必ず、次のセクションの下に正確なフィールド名と関連付けられたデータを入力してください。

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

  • 一時的なドキュメントとしてアップロードされたドキュメント内でテキストタグを使用:

    テキストタグが追加されたドキュメントを一時的なドキュメントとしてアップロードする場合は、必ず、次のセクションの下に正確なフィールド名と関連付けられたデータを入力してください。

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

特定のフォームフィールド(mergefield)に値があらかじめ入力されている API を使用して、契約書を送信する方法

この呼び出しの前提条件は、最初に「一時的なアップロード」手順を完了して、ここで使用するための「transientDocumentId」を取得することです(secure.na1.echosign.com/public/docs/restapi/v5#! /transientDocuments/createTransientDocument を使用)。

  • この呼び出しには、特定のフォームフィールドのデフォルト値が指定されている「mergeFieldInfo」セクションが含まれます。
  • これにより、API 呼び出しに、別のシステムからのデータが事前に入力されます。
  • 契約書のこれらのフィールドは、編集可能または読み取り専用のいずれかです。

 

前提条件:

  1. 一時的なドキュメント ID
  2. フィールド名とそれらの値

 

サンプルリクエスト呼び出し:

 

リクエスト:

POST /api/rest/v5/agreements HTTP/1.1

Host: api.na1.echosign.com(または、次の getbaseURis 呼び出しを使用して検索できるシャード名を指定できます:https://secure.na1.echosign.com/public/docs/restapi/v5#! /base_uris/getBaseUris)

Access-Token: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM*

x-user-email: sender@yourdomain.com

Content-Type: application/json

Cache-Control: no-cache

 

{

   "documentCreationInfo": {

       "signatureType": "ESIGN",

       "recipientSetInfos": [

           {

               "recipientSetMemberInfos": [

                   {

                       "email": “signerEmail@domain.com"

                   }

               ],

               "recipientSetRole": "SIGNER"

           }

        ],

      

       "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

       "message": "Please Sign this from us!",

       "fileInfos": [

           {

               "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT"

           }

       ],

       "name": "MSA Edited”,

        "mergeFieldInfo": [

            {

                "fieldName": "AccountName",

                "defaultValue": "Sam's Garage"

            },

            {

                "fieldName": "AccountNumber",

                "defaultValue": "8756999"

            },

            {

                "fieldName": "Zip",

                "defaultValue": "94501"

            },

            {

                "fieldName": "City",

                "defaultValue": "CityVille"

            },

            {

                "fieldName": "State",

                "defaultValue": "CA"

            },

            {

                "fieldName": "Street",

                "defaultValue": "123 Some Road"

            },

            {

                "fieldName": "Title1",

                "defaultValue": "COO"

            },

            {

                "fieldName": "Description",

                "defaultValue": "Some new description here"

            }

        ]

   }

 

}

 

この呼び出しへの応答は、以降の呼び出し(signingUrl、status、formData など)用にシステムに保存する必要がある「agreementId」です。

 

応答:

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

post /megaSigns/{megaSignId}/views」メソッドの実行中に、「Requested view is not available for the resource in the current state.」というエラーが表示されます。

以下のリクエストコードで入力された name パラメーターの値が無効な場合にエラーが発生します:

{
  "name": " "
}

例えば、MegaSign 契約書が既に「IN_PROCESS]の場合、「AUTHORING」として値を入力すると、上記のエラーが表示されます。入力された値が、契約書の現在のステータスに一致していることを確認してください。

put /megaSigns/{megaSignId}/state」メソッドの実行中に「No value provided for MegaSign cancellation info.」というエラーが表示されます。

このエラーは、リクエストコードに次のパラメーターが欠落している場合に発生します:

 "megaSignCancellationInfo": {
    "comment": "",
    "notifyOthers": false
  }

「Minimal Schema」を使用する代わりに、「Complete Model Schema」をクリックして、API 呼び出しを実行するための完全なリクエストコードを入力します。

MegaSign 契約書のステータスを変更するには、put /megaSigns/{megaSignId}/state を使用して、次の手順を実行します。

  1. V6 の REST API ドキュメントに移動 し、
    put /megaSigns/{megaSignId}/state メソッドを選択します。
  2. Authorization 値、および If-Match と megasignID も入力します。
    • megasignID を取得するには、get /megaSigns を使用します
    • If-Match を取得するには、get /megaSigns/{megaSignId} を使用し、ヘッダーの下で「Etag」を検索します。
  3. {
      "state": "CANCELED",
      "megaSignCancellationInfo": {
       "comment": "cancel",
       "notifyOthers": false
      }

Webhook を正常に登録するために、Webhook URL はこの検証リクエストに 2XX 応答コードで応答します。さらに、次の 2 つの方法のいずれかで同じクライアント ID 値を返すことができます。

  1. 応答ヘッダー X-AdobeSign-ClientId を使用。これは、リクエストに渡されるヘッダーと同じヘッダーで、応答にエコーバックされます。
  2. X-AdobeSign-ClientId のキーとその値(リクエストで送信されたクライアント ID と同じ値)を示す JSON 応答の本文を使用。

Adobe Acrobat Sign は X-AdobeSign-ClientId を示す 2xx 応答を受信します。ユーザーは、Webhook 内で適切に設定されているかどうかを確認できます。

Webhook URL は予期された動作で応答していません。Adobe Acrobat Sign が送信した POST 通知ごとに、URL は 2XX ステータスコードで応答し、リクエストヘッダーで送信されたクライアント ID(X-AdobeSign-ClientId)を応答ヘッダーで返します。

詳細については、次のリンクを参照してください:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

URL がこのプロトコルを順守できない場合、Adobe Acrobat Sign は、その URL がリクエストを確認しなかったものとみなし、信頼できるポリシーに従って再スケジュールを試みます。

Webhook が応答できず、最大再試行時間または最大再試行間隔のいずれかを超えた場合、Webhook は無効になります。

  Twitter™ および Facebook の投稿には、Creative Co の規約内容は適用されません。


契約書に関する情報の管理/取得

署名用に既に送信されたドキュメントを変更するには、既存の契約書を更新できる PUT /agreements/{agreementId} としてメソッドを使用します。次のリクエストコードで、一時 ID と契約書 ID を入力します。

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

Put /agreements/{agreementId}/state を使用して、ステータスを「AUTHORING」から「IN_PROCESS」に更新する手順は、次のとおりです。

  1. POST/Agreement メソッドを使用して検索した契約 ID を取得します。

  2. Get /agreements/{agreementId} を使用して、最新の ETag を取得します。

  3. Put /agreements/{agreementId}/state に移動し、次の情報を入力します: "state": "IN_PROCESS"

いいえ。

現在の REST API には、署名済みコピーをアップロードするメソッドはありません。

送信者は、管理ページから署名済みコピーをアップロードする必要があります。

DELETE /agreements/ID を使用して、管理ページから契約書を非表示にすることができます。

Adobe には、(Get /agreements で)契約書の表示を制御するための新しい API PUT /agreements/ID/me/visibility が用意されています。DELETE /agreements/ID によって提供される機能に加えて、新しい表示エンドポイントでは、「非表示」操作を元に戻すこともできます。つまり、契約書を再度表示することができます。

以下の詳細な手順に従うこともできます。

  1. get /agreements メソッドに移動して、契約書 ID を取得します。
  2. put /agreements/{agreementId}/me/visibility をクリックして、次のリクエストをサンプルとして入力します:
    {
      "visibility": "HIDE"
    }
    契約書 ID は get /libraryDocuments からのみ非表示になりますが、「管理」タブの UI では引き続き表示されます。
注意:

デフォルトでは、API 保持機能は無効になっています。

DELETE/agreements 操作を有効にするには、サクセスマネージャーに連絡して、アカウントの API 保持を有効にするように依頼します。

アカウントの保持機能を有効にする方法の詳細については、「Adobe Acrobat Sign - Document Retention」を参照してください。

  1. Adobe Acrobat Sign 管理者としてログインし、https://secure.adobesign.com/public/docs/restapi/v6 に移動します。

    • 契約書をクリックし、GET /agreements メソッドを展開します。
    • 「OAUTH アクセストークン」ボタンをクリックします。
    • agreement_read:self スコープを有効にします。
    • 認証」ボタンをクリックします。
      • 必要に応じて、アクセスを許可をクリックします。
    • Try it out! 」ボタンをクリックします。
    Get Agreement メソッド

  2. 応答が生成されます。

    agreementId は、応答の本文に示されています。

    Get Agreement 応答

  3. DELETE /agreements/{agreementId}/documents:1 つの契約書に関連するすべてのドキュメントを削除します。契約書自体は、管理ページに表示されたままになります。

    • 実行する DELETE/agreements 操作を選択します。
    • 「OAUTH アクセストークン」ボタンをクリックし、areement_retention スコープを持つアクセストークンを作成します。
    • 削除する契約書の agreementId を入力します。
    • 契約書が削除されると、応答の本文に「no content」と示されます。

DELETE/agreements 操作が無効な場合は、次の応答を受け取ります。

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": "The operation requires some account settings to be enabled.Please contact the Adobe Acrobat Sign team to enable the settings."

次のメソッドを使用して監査レポートをダウンロードするための個別の呼び出しを作成するのではなく、Adobe Acrobat Sign REST API を介して監査レポートと関係ドキュメントとともに署名済みドキュメントをダウンロードする方法。

GET /agreements/{agreementId}/auditTrail

  1. GET /agreements/{agreementId}/combinedDocument をクリックします。

  2. 「oAuth アクセストークン」ボタンをクリックします。

  3. アクセストークンは、認証が承認されると自動的に生成されます。

  4. agreementId を入力します。

  5. attachSupportingDocuments で、ドロップダウンから true を選択します。

  6. attachAuditReport で、ドロップダウンから true を選択します。

  7. 「Try it out!  ボタンをクリックします。

    結合ドキュメントを取得

    署名済みの関連ドキュメントと監査レポートが結合された PDF をダウンロードします。

一括でドキュメントをダウンロードするために使用可能なツールは、ドキュメント書き出しツールのみです。API では、ドキュメントを 1 つずつしかダウンロードできません。同じ目的の API メソッドは、次のとおりです。

https://secure.na1.adobesign.com/public/docs/restapi/v5#! /agreements/getCombinedDocument

Acrobat Signにアップロードするファイルはできるだけ短い日本語、または英語にしてください。Acrobat Sign にファイルをアップロードする際、ファイル名が日本語で記載されていて、かつ比較的長い場合に、エラーとなることがあります。APIからのコールでAcrobat Signへファイルがアップロードされると、ファイルのエンコーディングが行われます。この時に変換されたファイル名がAcrobat Signのファイルサイズ基準値である255バイトを超えてしまうことでエラーが生じます。


ライブラリテンプレートと Web フォーム

  1. 管理者として Adobe Acrobat Sign にログインし、https://secure.na1.adobesign.com/public/docs/restapi/v6 に移動します。

    • libraryDocuments をクリックし、GET /libraryDocuments メソッドを展開します
    • 「OAuth アクセストークン」ボタンをクリックします。
    • library_read:self スコープを有効にします
    • 認証」ボタンをクリックします。
      • 必要に応じて、アクセスを許可をクリックします。
    • Try it out! 」ボタンをクリックします。
    Get LibraryDocument メソッド

  2. 応答が生成されます。

    libraryDocumentId は、応答の本文に示されます。

    Get LibraryDocument 応答

Adobe には、(Get /agreements で)契約書の表示を制御するための新しい API PUT/libraryDocuments/ID/me/visibility が用意されています。DELETE /agreements/ID によって提供される機能に加えて、新しい表示エンドポイントでは、「非表示」操作を元に戻すこともできます。つまり、契約書を再度表示することができます。

以下の詳細な手順に従うことができます。

  1. get /libraryDocuments メソッドに移動し、契約書 ID を取得します。
  2. put /libraryDocuments/{libraryDocumentId}/me/visibility をクリックして、次のリクエストをサンプルとして入力します:
    {
      "visibility": "HIDE"
    }
    ライブラリ ID は get /libraryDocuments からのみ非表示になりますが、「管理」タブの UI では引き続き表示されます。
注意:
  • サポートチームにリクエストを送信して、ライブラリの削除に対して有効なスコープを取得します。
  • API がライブラリドキュメントを削除します。ただし、このライブラリドキュメントを使用して作成された契約書は影響を受けません。


libraryDocumentID の生成

  1. https://secure.echosign.com/public/docs/restapi/v5 に移動します。

  2. libraryDocuments をクリックします。

  3. oAuth アクセストークン」ボタンをクリックします。

    自分、グループまたはアカウントのアクセストークンを認証します。

  4. libraryTemplateType として、Document または Form_field_layer を選択します。

  5. Try It Out」をクリックします。

    すべてのテンプレートについて、次のような応答を受け取ることができます(削除するライブラリテンプレートの libraryDocumentId をコピーします)。

    { 
      "libraryDocumentList": [ { "name": "testing fields", "modifiedDate": "2017-08-04T01:06:05-07:00", "scope": "PERSONAL", "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", "libraryTemplateTypes": [ "DOCUMENT" 
          ] 
        },


ライブラリテンプレートを削除

  1. 応答本文から libraryDocumentID をコピーします。

  2. Delete libraryDocuments に移動します。

  3. 「oAuth アクセストークン」ボタンをクリックします。自分、グループまたはアカウントのアクセストークンを認証します。

  4. 値フィールドに libraryDocumentId を貼り付けます。

  5. Try it Out」をクリックします。 
    テンプレートが削除されます。

    応答コード:204 が表示されます。

注意:

Draft ステータスの Web フォームのみを更新できます。

  1. post /widgets を使用してウィジェットを作成します。

  2. get/widgets からウィジェット ID を取得します。

  3. GET /widgets/{widgetId} メソッドを使用して作成したら、応答ヘッダーから Etag を取得します。

    Foo

  4. put  /widgets/{widgetId} で、GET /widgets/{widgetId} から取得した Etag を使用します。If-Match パラメーターで、widgetId と widgetInfo を入力します。

    Foo

    { 
      "fileInfos": [ { "transientDocumentId": "******" } ], "name": "Widht_Name", "status": "DRAFT", "widgetParticipantSetInfo": { "memberInfos": [ { "email": "" } ], "role": "SIGNER" 
      } 
    }


使用例

  1. 正しい x-api-user を使用して get/agreements 呼び出しを作成します。

  2. 応答の本文で、目的の署名 URL を含む署名用に送信された契約書を検索し、契約書 ID をメモします。

  3. get/agreements 呼び出しで受け取った契約書 ID を使用して、get/agreements/{agreementId}/signingUrls 呼び出しを作成します。

     

    結果

    出力では、署名者の電子メールアドレスと電子サイン URL が返されます。

    Get Agreement メソッド

ヘルプをすばやく簡単に入手

新規ユーザーの場合

Adobe MAX 2025

Adobe MAX Japan
クリエイターの祭典

2025 年 2 月 13 日
東京ビッグサイト