開発者センター

エンベロープ送信ビューを作成

POST /esignglobal/v1/envelopes/views/sender

インターフェースの説明

封筒IDを使用して封筒送信者ビューを作成します。開発者は、このインターフェースから取得したページを使用して、送信ビューをサードパーティアプリケーションに統合できます。

  1. このビューから取得した署名開始ページから開始された署名プロセスは、開始者がOAuthのアクセストークンから解析されたユーザー情報で入力します。
  2. このインターフェースを呼び出す前に、署名プロセス作成インターフェースを使用して、ステータスが下書きの封筒を作成する必要があります。
  3. 署名プロセスIDを作成した後、署名ファイルを追加したり、署名者を追加したりするインターフェースを使用して、封筒を設定できます。
  4. このビューで生成された開始ページは、iframeとwebviewの埋め込みをサポートしており、ページ言語はデフォルトで英語です。
  5. このインターフェースの呼び出しは、署名者のサイレント署名を含む署名プロセスをサポートしていません。

リクエストパラメータ

パラメータ名

タイプ

必須かどうか

説明

envelopeId

string

true

署名プロセスID。0(作成済み(下書き))の署名プロセスIDのみを渡すことができます。

returnUrl

string

true

署名プロセスが完了した後のリダイレクトアドレス(長さ2048)。https / httpプロトコルアドレスに準拠する必要があります。

settingsobjectfalse送信ページのカスタム設定
 startingPagestringfalseビューの開始ページを送信します。デフォルトはpreparePageです。
preparePage - 基本情報設定ページ
taggingPage - 署名コントロール設定ページ
 submitActionstringfalse送信、デフォルトはsend
save - 保存、ページにsave保存ボタンを表示し、send関連ボタンを非表示にします。
send - 送信、ページにsend now、send、send laterボタンを表示し、saveボタンを非表示にします。
 showBackButtonbooleanfalseTagging PageのBackボタンを表示するかどうか。デフォルトはtrueです。
true - 表示
false - 非表示
 

lockedArea

arrayfalse

senderViewで変更できない情報。デフォルトは空です。列挙値は以下を含みます:

document - 署名ファイル

signerInfo - 署名者情報

リクエスト例

{
    "envelopeId":"75a12f86018040d58e4ba06d6bc9028d",
    "returnUrl":"ggg.fengli.com"
}

レスポンスパラメータ

パラメータ名

タイプ

説明

url

string

エンベロープ開始ページアドレス

レスポンス例

{
    "code": "0",
    "data": {
        "url": "https://app-test-as1.esignglobal-inc.com/document/refine-info?envelopeId=75a12f86018040d58e4ba06d6bc9028d&tcode=...&dc=as1"
    },
    "message": "success"
}

 

インターフェースの説明
リクエストパラメータ
リクエスト例
レスポンスパラメータ
レスポンス例