淘垦网

API 文档

淘垦网「ERP 接口顾问」——规范/知识即服务。我们不代查你的业务数据、不托管你的 ERP 凭证,只提供权威、可执行的各家 ERP OPEN API 对接规范。

目录
鉴权 列出规范 查询单条规范 自然语言检索 配额与限流 错误码 账户与 Key 当前规范库

鉴权

所有 /v1/erp/* 查询接口需要在请求头携带 API Key:

X-Api-Key: erp_xxxxxxxxxxxxxxxx

Key 在 控制台 注册生成(每账户最多 20 个,仅作鉴权凭证)。每个账户每月享有免费调用额度,调用时先扣免费额度、再扣资源包。

列出规范

GET/v1/erp/specs

参数位置说明
vendorquery,可选按厂商过滤,如 chanjet
scenarioquery,可选按场景过滤,如 stock_query
curl -H "X-Api-Key: 你的KEY" \
  "https://open.iosat.com.cn/v1/erp/specs?vendor=chanjet"

查询单条规范

GET/v1/erp/spec

参数位置说明
vquery,必填厂商,如 chanjet
squery,必填场景,如 stock_query
verquery,可选版本,缺省取最新
curl -H "X-Api-Key: 你的KEY" \
  "https://open.iosat.com.cn/v1/erp/spec?v=chanjet&s=stock_query"

返回完整规范:接口地址、鉴权方式、请求头、请求/响应示例、字段说明、错误码、实战 tips 与官方文档链接。

自然语言检索

POST/v1/erp/ask

curl -X POST -H "X-Api-Key: 你的KEY" -H "Content-Type: application/json" \
  -d '{"query":"查畅捷通库存怎么调"}' \
  "https://open.iosat.com.cn/v1/erp/ask"

按相关度返回最多 10 条匹配规范,适合接入 AI Agent 作为工具调用。

配额与限流

项说明
免费额度每账户 1000 次 / 月(每月 1 日自动重置),所有 Key 共享
资源包免费额度用尽后按资源包扣减(可购买 / 赠送 / 折扣)
每账户 Key 数最多 20 个(仅鉴权凭证)
超配额返回 429 quota_exceeded
企业版(更高配额 / SLA / 更多厂商规范)即将开放,可通过官网联系我们。

错误码

HTTPerror说明
401missing_api_key未携带 X-Api-Key
401invalid_api_keyKey 不存在或已吊销
429quota_exceeded本月配额已用尽
429rate_limited注册/登录过于频繁
404spec_not_found规范不存在
405method_not_allowedHTTP 方法不支持

账户与 Key(控制台接口)

以下接口供 控制台 使用,登录态通过 X-Session-Token 头或 Cookie 传递:

接口说明
POST/v1/auth/otp/send发送短信验证码(scene: register / login / change_phone)
POST/v1/auth/register注册:手机号 + 验证码 + 密码(两次确认),邮箱可选
POST/v1/auth/register/wechat微信授权后补录注册(仍需手机号 + 验证码 + 密码)
POST/v1/auth/login登录:账号(手机号或邮箱)+ 密码
POST/v1/auth/login/otp登录:手机号 + 验证码
POST/v1/auth/login/wechat/*微信登录(已绑直接登 / 未绑补手机号 / 未注册需设密码)
POST/v1/auth/profile/*修改手机号 / 邮箱 / 密码
GET/v1/auth/me当前账户资料
GET/v1/account/me我的信息:Key 列表 + 用量统计
POST/v1/account/keys生成 API Key(鉴权凭证)
POST/v1/account/keys/revoke吊销 Key

当前规范库(28 条)

vendorscenario标题版本
chanjet authorize 授权绑定(获取 openToken) 1.0.0
chanjet balance_sheet_query 科目余额表查询(GetBalanceSumRpt) 1.0.0
chanjet business_vouchers_detail 业务单据明细报表(进货/付款/收款/生产加工/费用) 1.0.0
chanjet financial_report_query 财务报表查询(FindTUFOTable) 1.0.0
chanjet integration_guide 对接总览与接入指南 1.0.0
chanjet inventory_class_query 存货分类查询 1.0.0
chanjet inventory_query 存货档案查询 1.0.0
chanjet material_dispatch_detail 材料出库单明细表 1.0.0
chanjet order_bills 订单单据查询(总览) 1.0.0
chanjet partners_account_query 往来期间对账单查询(PartnersAccountRpt/Query) 1.0.0
chanjet product_receive_detail 产成品入库单明细表 1.0.0
chanjet purchase_order_detail 采购订单明细表 1.0.0
chanjet purchase_order_executing 采购订单执行情况 1.0.0
chanjet purchase_receive_detail 采购入库单明细表 1.0.0
chanjet report_analysis_query 账龄分析与现金流量报表 1.0.0
chanjet report_query 报表查询 1.0.0
chanjet sale_delivery_detail 销货单明细表 1.0.0
chanjet sale_dispatch_detail 销售出库单明细表 1.0.0
chanjet sale_order_detail 销售订单明细表 1.0.0
chanjet sale_order_executing 销售订单执行情况查询 1.0.0
chanjet stock_increment_query 现存量增量查询 1.0.0
chanjet stock_inout_bills 出入库单据查询(总览) 1.0.0
chanjet stock_query 库存查询 1.0.0
chanjet stock_summary 收发存汇总表 1.0.0
chanjet warehouse_list 仓库列表 1.0.0
tuya device_control 设备查询与控制(按账户隔离) 1.0.0
tuya device_oauth 账户授权与设备同步(终端用户接入) 1.0.0
tuya infrared_control 红外遥控(云项目级通道) 1.0.0

规范库持续扩充中;在 规范库门户 可免 Key 在线浏览。