docs(external-entry): hide internal identity parameters
This commit is contained in:
@@ -24,4 +24,4 @@ APP HOST:`cozsweet.com`
|
||||
| 图片促销 | `promotion` | `image` | [打开图片促销](https://cozsweet.com/external-entry?target=chat&mode=promotion&promotion_type=image) |
|
||||
| 私密文本促销 | `promotion` | `private` | [打开私密文本促销](https://cozsweet.com/external-entry?target=chat&mode=promotion&promotion_type=private) |
|
||||
|
||||
如需传递 Facebook 身份信息,可在任一链接末尾追加 `&asid=<ASID>&psid=<PSID>`。ASID 和 PSID 均为可选参数。
|
||||
如需传递 Facebook 身份信息,可在任一链接末尾追加 `&psid=<PSID>`。PSID 为可选参数。
|
||||
|
||||
@@ -11,29 +11,27 @@
|
||||
|
||||
入口会先保存传入的身份数据,再使用 `replace` 跳转到目标页面。身份参数和入口控制参数会从地址栏中移除;目标页面自身需要的状态参数会保留,例如打赏页的 `coffee_type`。
|
||||
|
||||
如果进入时已经是 Email、Google 或 Facebook 正式登录用户,并且携带 ASID 或 PSID,入口会额外调用一次 Facebook Identity 绑定接口。普通启动、刷新、Guest 和未登录状态不会调用绑定接口,绑定失败也不会阻止目标页面跳转。
|
||||
如果进入时已经是 Email、Google 或 Facebook 正式登录用户,并且携带 PSID,入口会额外调用一次 Facebook Identity 绑定接口。普通启动、刷新、Guest 和未登录状态不会调用绑定接口,绑定失败也不会阻止目标页面跳转。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 必填 | 可选值 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| `target` | 否 | `chat`、`tip`、`private-room` | 最终页面,缺失或无效时进入 `chat`。 |
|
||||
| `device_id` | 否 | string | 外部设备 ID。 |
|
||||
| `asid` | 否 | string | Facebook App-scoped User ID。 |
|
||||
| `psid` | 否 | string | Facebook Page-scoped User ID。 |
|
||||
| `avatar_url` | 否 | URL string | 用户头像地址。 |
|
||||
| `coffee_type` | 打赏入口可选 | `small`、`medium`、`large` | `target=tip` 时指定咖啡档位,缺失或非法时默认为 `small`。 |
|
||||
| `mode` | 否 | `promotion` | 设置为 `promotion` 时尝试开启聊天促销模式。 |
|
||||
| `promotion_type` | 促销模式必填 | `voice`、`image`、`private` | 指定促销锁消息类型。 |
|
||||
|
||||
参数名称只接受表格中的规范写法,不兼容 camelCase、旧 Facebook 字段名、`redirect`、`next` 或其他目标别名。
|
||||
对外接入应使用表格中的公开参数及规范写法,不兼容 camelCase、旧 Facebook 字段名、`redirect`、`next` 或其他目标别名。
|
||||
|
||||
## 普通入口
|
||||
|
||||
进入聊天:
|
||||
|
||||
```text
|
||||
https://<APP_HOST>/external-entry?target=chat&asid=<ASID>&psid=<PSID>
|
||||
https://<APP_HOST>/external-entry?target=chat&psid=<PSID>
|
||||
```
|
||||
|
||||
进入打赏页面(默认 Small Coffee):
|
||||
|
||||
Reference in New Issue
Block a user