若 App 首次对接,请联系好车主侧配置白名单
***
# **好车主基础&鼎聚字段对接**
如电话会议沟通
* **鼎聚侧负责**:维护活动信息(活动名称、背景、按钮文案)、三方 App 信息(包括 Scheme、包名、Universal Link 等基础唤端参数)的配置与管理。
* **好车主侧负责**:基于上述配置,负责主要信息的查询、组装及前端唤端逻辑的实现。
若对本文档中的字段定义、默认值逻辑或交互流程有任何异议或疑问,请及时沟通确认,谢谢
## 1. 唤端相关参数(必传基础信息)
以下参数用于标识目标应用及识别当前环境,**均为必填项**。
| 字段名称 | 例·字段标识 (Key) | 类型 | 必填 | 默认值/备注 | 说明 |
| :--- | :--- | :--- | :--- | :--- | :--- |
| **Scheme** | `scheme` | String | **是** | - | 自定义协议头,用于标识特定应用。例如:`pingan` |
| **Universal Link** | `universal_link` | String | **是** | - | iOS Universal Link 地址,用于 iOS 系统唤起 App。例如:`https://www.pingan.com/deeplink` |
| **Android Package Name** | `android_pkg_name` | String | **是** | - | 安卓应用包名。例如:`com.pingan.app` |
| **iOS Bundle ID** | `ios_bundle_id` | String | **是** | - | iOS 应用 Bundle ID。例如:`com.pingan.ios` |
| **HarmonyOS Bundle Name** | `harmony_bundle_name` | String | **是** | - | 鸿蒙应用包名。例如:`com.pingan.harmony` |
| **微信环境标识** | `is_wechat` | Boolean | **是** | `false` | 标识当前是否在微信环境中。
默认值为 `false`。
若为 `true`,需在逻辑中额外处理微信白名单或跳转提示。 |
>
---
## 2. 活动相关参数(选传业务信息)
以下参数用于控制唤端行为的 UI 表现及业务逻辑,**均为非必填项**。若未传入,将采用默认配置。
字段命名按你们规范来
| 字段名称 | 例·字段标识 (Key) | 类型 | 必填 | 默认值 | 说明 |
| :--- | :--- | :--- | :--- | :--- | :--- |
| **页面标题** | `page_title` | String | 否 | -| 导航栏标题文本。默认值为空 |
| **活动名称** | `activity_name` | String | 否 | - | 业务活动名称,主要客户端拦截弹窗展示活动文案。 |
| **活动背景图链接** | `bg_image_url` | String | 否 | - | 背景图片 URL |
| **是否需要按钮** | `need_button` | Boolean | 否 | `true` | 控制是否展示“立即打开”按钮。
**逻辑说明:**
- **`true` (是)**:页面上出现按钮,用户点击按钮触发唤端逻辑。
- **`false` (否)**:页面上无按钮,但用户点击页面任意空白区域(或特定区域)也会触发唤端逻辑。 |
| **按钮文案** | `btn_text` | String | 否 | `打开应用` | 字数限长12。超出部分会截断 |
### 字段对应关系
> *客户端弹窗*
>
>
---
## 3. 参数汇总示例 (JSON)
以下是一个标准的 JSON 请求/配置示例,供参考:
```json
{
"scheme": "pingan://",
"universal_link": "https://www.pingan.com/deeplink",
"android_pkg_name": "com.pingan.app",
"ios_bundle_id": "com.pingan.ios",
"harmony_bundle_name": "com.pingan.harmony",
"is_wechat": true,
"activity_name": "鼎聚联合活动",
"bg_image_url": "https://********/activity/bg.jpg",
"need_button": true,
"page_title": "页面标题",
"btn_text": "按钮文案"
}
```