Overview

Integration Scenarios

The integrator application embeds two functional entry points in the toolbar or promotional area:

• Initiate Signing — After the integrator application completes OAuth authorization, it calls Upload File to obtain a FileId, then calls Get Embedded View URL to bind the FileId to the embedded page URL, and finally opens the embedded page via WebView to complete the envelope creation flow (set recipients → place signature areas → send)
• Signing Status — Exchange for an embedded page URL; the WebView directly displays the contract list of the current account under the selected Space

The embedded pages are provided by Tencent eSign and support integrator branding (see Embedded Views - Branding). They interact with the Tencent eSign server side via a webview token.

Access Modes

OAuth Authorization Modes

This guide supports two authorization modes for different integration scenarios:

• Open Mode (default) — Targets C-end users. Each email can initiate authorization independently. The Space is selected by the user on the Consent page or auto-created by the system. The authorization URL does not require space_id
• Designated Space Mode — Targets enterprise/organization scenarios. The authorization target is limited to a Space pre-designated by the integrator. Requires the Pre-add Members API to pre-add members. The authorization URL must include both space_id and login_hint. See OAuth Authorization Flow - Designated Space Mode

Core Concepts

Key Constraints

1. The integrator accesses via the third-party app mode (third_party app)
2. The integrator first self-registers an account in the Tencent eSign console (creating an integrator Space). The admin of that Space creates an OAuth app in the console, which directly generates client_id / client_secret. In multi-region scenarios, the integrator must register separately in each region and create an app in each; credentials are isolated by region and not interchangeable (billing resource packages are also region-closed)
3. First-time user access (both modes):
   • Open Mode — The integrator can pass login_hint (user email) when opening the authorization page for pre-filling; if the email is not yet registered with Tencent eSign, the system automatically and silently completes registration and creates a default Space (the user is the admin). No space_id needs to be passed; the user selects the Space on the authorization page
   • Designated Space Mode — The integrator passes both space_id and login_hint. The system does not auto-create a Space; the user must have been pre-added as a pending member of that Space via the Pre-add Members API. Clicking “Agree” during authorization is treated as accepting the invitation and completing activation. See OAuth Authorization Flow - Designated Space Mode
4. Automatic app installation — When a user completes authorization on the Consent page, if the current Space has not yet installed the integration app and the user is an admin, Tencent eSign automatically completes the installation transparently to the user
5. After the integrator application calls the Upload File API to obtain a FileId, it binds the FileId to the webview token via the OperateParam.FileIds field of the Get Embedded View URL API. The embedded page can use it immediately upon loading

Responsibilities

Integrator Responsibilities

Tencent eSign Responsibilities

Related APIs