Open API

开发者板块

面向外部系统接入。使用商家后台生成的 API Key，以当前门店身份调用 Foodiy Open API。

API Key

商家后台路径：设置 / 开放平台。新密钥会返回完整明文，后续可在同一页面再次查看。

Headers

Base URL：`https://openapi.foodiy.net`。写入接口每次只处理一个 JSON 资源，并需要 `Idempotency-Key`。

认证

Authorization: Bearer fdy_open_xxxContent-Type: application/jsonIdempotency-Key: 4f0d4a26-7d9c-4d35-8f0a-6ec9b2b17b2c

写入标准

Open API 按资源逐条创建和更新。一个 POST、PATCH 或 PUT 请求只提交一个分类、商品或绑定资源；批量同步由调用方拆分成多次请求，每次使用独立幂等键。开放平台不接收 CSV 文件或批量数组载荷。

商品目录 API

方法路径Scope说明
GET/api/v1/open/catalog/categoriescatalog:read读取分类列表
POST/api/v1/open/catalog/categoriescatalog:manage创建分类
GET/api/v1/open/catalog/productscatalog:read读取商品分页
POST/api/v1/open/catalog/productscatalog:manage创建商品
PATCH/api/v1/open/catalog/products/{id}catalog:manage更新商品，需携带 version 或 If-Match-Version
PUT/api/v1/open/catalog/products/{id}/availabilitycatalog:manage上下架商品
PUT/api/v1/open/catalog/products/{id}/categoriescatalog:manage替换商品分类绑定

Scope

  • orders:read：读取当前门店订单。
  • crm:deliver：处理 CRM 投递任务。
  • catalog:read：读取当前门店分类和商品。
  • catalog:manage：创建、更新、上下架和归档当前门店分类与商品。