科技背景
👨‍💻 DEVELOPER GUIDE

开发者指南 金蝶云・星辰 API 集成与扩展开发

技术开发 + 集成实战

核心开发体系:API/SDK/扩展开发

集成对接:第三方系统集成实战

🔧 API开发 📦 SDK集成 🔌 系统对接 🚀 扩展开发
🔐 鉴权快速开始

5 分钟跑通 API 鉴权

app_key + app_secret → access_token → 业务接口(OAuth 2.0 授权码模式)

鉴权流程(4 步)

  1. 1 在金蝶云·星辰开放平台后台申请应用,获取 app_keyapp_secret
  2. 2 引导用户在授权页同意后回调拿到 code,再换取 access_token(有效期 2 小时)
  3. 3 调用业务接口时在 Header 携带 access_token,并按接口要求传入 accountId / tenantId
  4. 4 过期前 30 min 用 refresh_token 静默续签,避免业务调用中断
常见坑:access_token 全局唯一,不要并发刷新;refresh_token 仅可使用一次,必须替换保存。

curl 示例(获取 access_token)

# 1. 用授权码换 access_token
curl -X POST https://openapi.kingdee.com/koas/APP000041/api/oauth2/access_token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=authorization_code" \
  -d "app_key=YOUR_APP_KEY" \
  -d "app_secret=YOUR_APP_SECRET" \
  -d "code=USER_AUTH_CODE"

# 返回
# {
#   "access_token": "xxx",
#   "refresh_token": "yyy",
#   "expires_in": 7200,
#   "accountId": "123456"
# }

# 2. 携带 token 调用业务接口
curl -X GET https://openapi.kingdee.com/jdy/v2/scm/inv_real_qty \
  -H "Access-Token: xxx" \
  -H "X-Account-Id: 123456"

具体 endpoint 与字段以 官方鉴权文档为准

🔧 核心开发体系

API/SDK/扩展开发

官方核心资源 + 第三方实战指南

官方核心资源

📚

金蝶云星辰 API 接口数据字典

涵盖全量 API 接口详情,包括接口名称、功能描述、请求参数及返回结果,适配 V7.6 版本

查看详情
📦

WebAPI 新版资料包

含理论介绍与实际案例,助力快速上手 API 对接,支持下载学习

下载学习
🔧

API 接口调用 SDK

集成高效、安全可靠,附实例代码,覆盖 Java / Python / Node.js 多语言场景

查看 SDK
🎓

前置基础:金蝶开发者初级认证

星辰扩展开发的官方前置课程,ISV 伙伴准入要求需 4 人获取该认证;课程基于金蝶开发者学院通用体系

开始认证
🚀

前置基础:低代码开发入门学习营

为星辰扩展开发打基础,覆盖低代码开发核心能力(金蝶开发者学院开放课程)

加入学习营

API 分类总览

金蝶云·星辰开放 API 覆盖 5 大业务域,选需接入

📋

订单

销售单 / 采购单 / 退货单 CRUD、状态流转、审批

📦

库存

即时库存查询、入/出库、调拨、盘点、批次/序列号

🏷️

商品

物料档案、SKU、价目表、分类、货位

👥

客户/供应商

基础档案、联系人、信用额度、应收/应付

💰

财务

凭证、科目、期初/期末、报表、发票

错误码快查: 10001 鉴权失败 · 10002 token 过期 · 20001 参数错误 · 40001 资源不存在
限流策略: 默认 10 QPS / 应用、日调量 10 万次;建议使用令牌桶 + 重试退避,超限返回 429

第三方实战资源

💻

即时库存查询 API 调用示例

Java / Python / Node.js 代码片段集合,演示 HTTP GET 请求获取商品可用数量、批次/序列号等场景

查看代码

星辰 API 对接常见问题汇总

接口授权、参数封装、调试排错经验与官方解答

查看 FAQ
🎨

低代码扩展开发技巧

金蝶官方开发者社区分享星辰定制化开发思路,适配中小企业个性化需求

学习技巧
🔌 集成对接与开发规范

第三方系统集成实战指南

官方配置指南 + 实战案例分析

官方集成资源

🔑

第三方系统授权配置指南

详解三方授权信息新增、账户登录注册流程,为 API 对接铺垫权限基础

查看指南
📋

ISV 扩展开发准入要求

明确加盟条件、认证要求及产品规划方案立项评审标准

查看要求

第三方集成案例

🛒

星辰与电商平台数据同步实战

讲解订单、库存数据对接逻辑,附接口测试工具使用方法

查看案例
💳

财务系统与星辰 API 对接教程

分享凭证数据交互、期初余额导入等核心场景实现方案

查看教程
🗺️ 学习路径指南

开发者学习路线图

推荐学习顺序与时间规划

全程推荐周期:6–9 周(按每日 2–3h 估算)
每阶段含 验收 Checkpoint,过关后再进入下一阶段
1

基础准备阶段 (1–2 周 / Day 1–10)

  • D1–3完成金蝶开发者初级认证课程,记录 OAuth 2.0 授权码模式流程图
  • D4–6通读 API 接口数据字典,梳理出项目需要的 ≥5 个核心接口清单
  • D7–9在星辰开放平台创建沙箱应用,获取 app_key/app_secret,配置回调域名
  • D10阅读并调试本页「鉴权快速开始」的 curl 示例
Checkpoint 1:能用 curl/Postman 独立拿到 access_token,并调通 1 个查询类接口(如「商品列表」)。
2

API 开发阶段 (2–3 周 / Day 11–25)

  • D11–13集成官方 SDK(Java / Python / Node.js 任选),封装 token 管理器、自动续签
  • D14–17覆盖商品 / 库存 / 客户 3 大业务域的查询 + 写入,编写单元测试
  • D18–21实现订单状态机(创建 → 审批 → 出库 → 完成),覆盖未报错误码 10001/10002/20001/40001
  • D22–25引入令牌桶限流 + 指数退避重试,压测验证 10 QPS 上限
Checkpoint 2:SDK 可连续运行 ≥ 24h 不崩,token 自动续签零人工干预;错误码均有业务友好提示。
3

集成实战阶段 (3–4 周 / Day 26–45)

  • D26–30完成「星辰 ↔ 电商平台」订单/库存双向同步,重点解决幂等性与冲突处理
  • D31–35完成「财务系统 ↔ 星辰」凭证生成 + 期初余额导入,产出对账报表
  • D36–40低代码扩展:为某个业务场景加定制字段/按钮,调用身份鉴别与权限接口
  • D41–45生产发布:重调服务 + 告警接入(超限、超时、认证失败),整理运维 Runbook
Checkpoint 3:生产环境 7 天内接口成功率 ≥ 99.5%,告警闭环平均 ≤ 15min,完成 1 次实战复盘。
相关推荐

看完开发者指南后,你可能还想了解

核心 Demo 在线体验

真实业务样板:订单同步 / 电商对接 / 智能凭证

立即体验 Demo

1 对 1 技术诊断

免费 30min 接口设计 / 集成方案咨询

预约咨询

开发者社群

星辰 / 苍穹 开发者群聊,高频问答 + 资料分享

加入社群

遇到接口对接难题?我们帮你 7 天落地

上海思扬信息科技 · 金蝶生态服务商 · 累计交付 200+ 集成项目