把查端流程接入你的应用
Screenshare API 为服务器插件、机器人和 Partner 管理后台提供稳定的查端记录、邀请、工单进度和服务权益接口。Webhook 在业务变化时通知你的接收端。
生产地址：https://api.screenshare.cn/v1 · 当前版本：v1
从这里开始
- 在 个人中心的 API & Webhooks 生成密钥。
- 阅读 快速开始 并调用
GET /v1/me，确认凭证绑定的组织和权限。 - 有多个组织时，先完成 多组织接入 的凭证映射。
- 按 一次性邀请链接 实现生成、分发、玩家认领和结果同步。
- 配置 Webhook，在工单及查端记录变化时获取通知。
v1 能做什么
| 能力 | 个人密钥 | 组织密钥 |
|---|---|---|
| 精确查询公开 USS 查端记录 | public:read |
public:read |
| 查询个人服务权益 | entitlements:read |
不支持 |
| 查询绑定组织的记录 | 不支持 | records:read |
| 生成、读取、取回和撤销邀请 | 不支持 | invitations:read / invitations:write |
| 查询组织工单进度 | 不支持 | tickets:read |
| 查询绑定组织的权益 | 不支持 | entitlements:read |
| 订阅组织业务事件 | 在个人中心另行配置，须具有该组织的管理员成员身份 | 同左 |
组织密钥只绑定一个组织。账号同时管理多个组织时，应创建不同密钥。Admin、SSer 等站点角色不会自动给予第三方应用跨组织访问权。
人和 AI 都能读取
- OpenAPI JSON：请求参数、响应字段、认证和错误结构。
- llms.txt：供 AI 查找文档的索引。
- llms-full.txt：完整纯文本手册。
- 每篇文档均提供原始 Markdown 下载，所有示例使用虚构数据。
范围与边界
v1 提供工单进度，包括状态和消息数量。它不开放工单正文、远程设备密码、附件下载、联系方式、内部查端备注、账号安全资料或后台管理操作。自动处理详细会话、支付、成员管理和 OAuth 用户授权不在本次版本范围内。
“未找到记录”不等于“查端通过”；历史通过记录也只描述相应查端时间的结论。接入方应保留结果时间，并处理后续更正和删除事件。