外部数据集成

通过 API 接口让外部系统访问和管理你的物品数据。

什么是外部数据集成？

外部数据集成提供 API 接口，让外部程序可以：

• 查询和搜索物品
• 添加新物品
• 调整物品数量（入库/出库）
• 添加物品日记

进入外部数据集成

• 点击首页左上角打开侧边菜单
• 点击「外部API」
• 进入外部数据配置页面

API Key 管理

使用 API 要先获取 API Key：

什么是 API Key

• API Key 是访问接口的「密码」
• 每个用户有专属的 API Key
• 调用 API 时需要携带 API Key 进行身份验证

获取 API Key

• 进入外部数据页面
• 点击「获取 API Key」按钮
• 系统生成你的专属 API Key
• 复制保存 API Key

重新生成 API Key

• 点击「重新生成」按钮
• 确认重新生成
• 旧的 API Key 失效
• 需要更新所有使用旧 Key 的配置

使用场景

AI 助手集成

• 在 ChatGPT、Claude 等 AI 助手中配置 API
• 让 AI 助手帮你查询物品信息
• 通过对话添加或管理物品

iOS Shortcuts 快捷指令

• 在 iPhone 上创建快捷指令
• 通过 API 接口操作物屿
• 一键查询、添加、更新物品
• 可以在桌面添加快捷指令图标

自动化脚本

• 编写 Python/Node.js 脚本
• 定时同步数据或批量处理
• 适合有开发能力的用户

API 接口说明

提供的 API 接口包括：

查询物品

• 搜索物品
• 按条件筛选
• 获取物品详情

保存物品

• 添加新物品
• 设置名称、数量、价格等

调整数量

• 入库（增加数量）
• 出库（减少数量）
• 记录操作日期和备注

添加日记

• 为物品添加日记记录
• 记录使用情况或事件

接口地址

API 接口地址：`https://receptacle-server.maozla.com/external/api/v1/`

• 物品查询：`/goods/query`
• 保存物品：`/goods/save`
• 调整数量：`/goods/adjustQuantity`
• 添加日记：`/goods/diary/save`

注意事项

• 外部数据集成功能需要会员权限
• API Key 请妥善保管，不要泄露
• 调用 API 时需要携带 Authorization 头
• 适合有技术基础的用户或开发者