API 端点
这些是用于前端集成现场通知和富收件箱的可用端点。这些端点为已登录用户返回数据。
获取配置并验证用户
获取配置
GET https://am-events-[env].fasttrack-solutions.com/api/v1/config/[brand]
此端点返回您品牌所需的配置值
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
brand* | String | 集成管理员提供给您的"Fast Track 品牌名称" |
env* | String | 当前环境，可以是 staging 或空值（表示生产环境）。 |
200: OK
验证
POST [FUSION_URL]/Platform/LoginAuthToken
登录端点，将 sid / 认证令牌交换为用户对象。
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
authtoken* | String | 用于验证用户的 sid / 认证令牌 |
200: OK
针对 Pusher 进行验证
GET [FUSION_API]/external/pusher/[brand]?authToken=[sid]
此端点通常由前端 Pusher Javascript SDK 使用。
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
brand* | String | 集成管理员提供给您的"Fast Track 品牌名称" |
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
authToken* | String | 用于验证用户的 sid / 认证令牌 |
200: OK
消费数据
获取所有通知
GET [FUSION_URL]/Notifications/v2/user-notifications
列出已验证用户的所有通知。使用查询字符串参数来筛选通知。
DisplayType 可用于发送静默收件箱通知。CRM 中有一个静默通知复选框。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
unread-only* | boolean | 仅返回未读通知 |
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
authtoken* | String | 当前已登录用户的 sid / 认证令牌。 |
200: OK
获取特定通知
GET [FUSION_URL]/Notifications/v2/user-notification/[id]
返回已验证用户的特定通知。在 URL 中传递消息 ID。
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
id* | Integer | 要检索的消息 ID |
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
authtoken* | String | 当前已登录用户的 sid / 认证令牌。 |
200: OK
删除富收件箱消息
DELETE [FUSION_URL]/Notifications/v2/user-notification/[id]
为已验证用户删除富收件箱消息。这样该消息就不会在 API 中再次返回。
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
id* | Integer | 要删除的消息 ID |
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
authtoken* | String | 当前已登录用户的 sid / 认证令牌。 |
200: OK
将通知标记为已读
POST [FUSION_URL]/Notifications/MarkNotificationAsRead
为已验证用户将现场通知或富收件箱消息标记为已读
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
authtoken* | String | 当前已登录用户的 sid / 认证令牌。 |
请求体
| 名称 | 类型 | 描述 |
|---|---|---|
MessageId* | Integer | 要标记为已读的消息 ID |
200: OK