用途:通过平台 API 以键值存储方式,按“每个用户 × 每个组织”读写元数据,可用于用户偏好、应用设置、功能开关、引导进度等场景。同一用户在不同组织下拥有相互独立的元数据对象。
主要能力:所有操作命中 …/dm/api/core/users/platform-metadata/ 接口,并携带 ?platform_key={org}。GET 读取完整元数据对象,首次访问会自动创建记录,无数据时返回 metadata 为 {} 的 200,而非 404。PATCH 为合并式更新,可同时传入 metadata 与 delete_keys,先更新后删除,键同时出现在两处时最终被移除。PUT 为整体替换,未包含的键全部被删除,请求体必须为 metadata 包裹的 JSON 对象。DELETE 将元数据重置为 {}(记录保留),返回 204。管理员可通过附加 &username={other_user} 操作其他用户。
用法:基址 https://api.iblai.app,每个请求需带 Header Authorization: Api-Token $IBLAI_API_KEY;{org} 用 $IBLAI_ORG,{username} 用 $IBLAI_USERNAME。例如增量更新可执行:curl -X PATCH "https://api.iblai.app/dm/api/core/users/platform-metadata/?platform_key=$IBLAI_ORG" -H "Authorization: Api-Token $IBLAI_API_KEY" -H "Content-Type: application/json" -d '{ "metadata": { "onboarding_step": "3", "theme": "dark" } }'。若尚未连接,先运行 /iblai-api-login 填充环境变量。
适用场景与限制:适合需要无界面地管理用户级设置的集成。键值无 schema、命名空间或类型约束,需自行约定。PATCH 适合增量更新,PUT 和 DELETE 具有破坏性,操作前应确认。跨用户访问要求调用者是目标组织的管理员,否则返回 403;目标用户不存在返回 404;缺少 platform_key 返回 400;未知 platform_key 返回 404;PATCH 未提供 metadata 或 delete_keys 返回 400;PUT 的 metadata 非对象返回 400;缺少或无效鉴权返回 401。username、platform_key、created_at、updated_at 为只读,时间戳为 ISO 8601。更深入概念(四类数据、四个用例模式、最佳实践与 schema 迁移策略)见 references/guide.md。
其他收费、平台支持范围等信息暂未提供。