订户(端点)
订户是你数据的一个去处:一个 URL、一种数据、一个可选的转换脚本。所有 出站流量都在这里配置——除此之外,Courier 没有任何往外发数据的途径。
字段参考
| 字段 | 含义 |
|---|---|
| 名称 | 显示名,用于台账、通知与 context.endpointName |
| 类型 | 该订户接收的数据:workout(运动)/ sleep(睡眠)/ note(批注)/ weather(天气)。一个订户 = 一种类型 |
| URL | 目的地。要求 HTTPS(本地调试允许 http://localhost) |
| 方法 | GET / POST / PUT / PATCH / DELETE,默认 POST |
| 请求头 | 每次请求都带的静态、非密钥头 |
| 鉴权 | 密钥的附着方式:Bearer(Authorization: Bearer <密钥>)、自定义头(头名自取)、查询参数(参数名自取)或无 |
| 密钥 | 存在 iOS 钥匙串,不进数据库、不进配置备份 |
| Body 参数 | 静态键值对。POST 时并入 JSON body;其他方法拍平进查询串 |
| 含路线 | 仅运动:附上 GPS 轨迹(可能很大) |
| 含心率序列 | 仅运动:附上完整心率时间序列(大) |
| 自动发行 | 新数据到达即自动发给本订户。关掉则只收手动/批量发行 |
| 关联天气 | 仅睡眠订户:睡眠发行成功后,顺带把此刻天气发给选定的天气订户 |
| 天气每日一次 | 开启关联天气时:每天只有首次睡眠携带天气(午睡不再重发) |
| 转换脚本 | 可选 JavaScript,接管请求体的生产——见JavaScript 转换脚本 |
请求长什么样
不挂转换脚本时,请求体就是该类型的 canonical 记录——一份稳定、带版本号 的 JSON 文档(结构见数据参考), 再并入你的 Body 参数。每次请求都带 Idempotency-Key 头;确切语义见 发行与同步。
2xx 响应算成功;其余状态码会进入重试/待处理流程,响应记录在发行台账里。
测试订户
编辑页的测试按钮会拿一条近期样本走完整条管线——包括你的转换脚本、鉴权 与请求头——并在 App 内显示 HTTP 状态与响应体。调到服务器满意为止,再开 自动发行。
常见玩法
- 同一 URL,两种数据:建两个指向同一端点的订户,一个收运动、一个收 睡眠,服务端按 payload 分流。
- 天气日志:建一个
weather订户,再在睡眠订户里关联它——每天早晨的 发行,睡眠旁边就躺着当天的天气。 - 一发多收:同一种数据可以有任意多个订户;每次发行独立记账,一个端点 挂了不影响其他端点。