Published at: 2026-10-12
Development Guide
Configure the connector’s authorization method and authorization parameters.
Overview
By configuring the authorization method, a connector can integrate with a third-party platform’s authentication mechanism. OAuth 2.0 is the most commonly used authorization method.
Before You Begin
❗
- Role permission: Your organization must be included in the limited rollout enabled by R&D to access the Connector Development page
- Prerequisite configuration: You have obtained the Client Key and Client Secret from the target system app
Step 1: Enter the Connector Development Page
On the Setup > System Integration Platform > Connector Development page, select the connector to configure.
Step 2: Choose the Authorization Method
In the authorization configuration, choose the authorization method based on the target system’s authentication mechanism.
Step 3: Configure Authorization
Taking OAuth 2.0 authorization configuration as an example, the following steps are required:
- Configure authorization fields (optional; only added when extra parameters are needed before OAuth 2.0 login authorization)
- Copy the callback address and add the automatically generated integration platform authorization callback address to your app
- Configure authorization parameters, generally the Client Key and Client Secret
- Configure API parameters, including parameters required by the authorization API, Access Token exchange and refresh parameters, and so on
- Run account authorization test to simulate account authorization and test whether data can be retrieved successfully
📝
Unified developer creation generally only applies when serving as an integration platform ISV vendor. If the user has a custom app, choose user self-creation. The difference is that with unified developer creation, the authorized app reuses the same app information.
Step 4: Configure the Authorization Type
The OAuth authorization type specifies the OAuth 2.0 authorization method used when a connector integrates with a third-party platform.
Authorization type | Description |
|---|---|
OAuth 2.0 (Authorization Code) | The user completes login authorization and then obtains an access token |
OAuth 2.0 (Client Credentials) | The system uses client credentials to obtain an access token directly, without user involvement |
OAuth 2.0 (PKCE) | Adds PKCE verification on top of the authorization code mode, for frontend or mobile scenarios |
Step 5: Configure the Authentication Address
Configure the authorization address, Token retrieval address, and Token refresh address.
Expected Result and Verification
After completing the authorization configuration, the account authorization test passes and the connector can retrieve data from the target system normally.
Verification method:
- On the authorization configuration page, click Account Authorization Test.
- Check whether the test result indicates successful retrieval.
- If it fails, check the Client Key, Client Secret, and callback address against the error prompt.