金蝶云苍穹OpenAPI：开发认证指南

1. 简介

本文档适用于外部系统与金蝶云苍穹间的系统集成场景。当外部系统调用金蝶云苍穹OpenAPI时，金蝶云苍穹会对每个API进行身份鉴权，判断其请求合法性，最后响应API请求。

2 认证方式

路径：【开放服务云】→【OpenAPI】→【第三方应用】，在第三方应用中为外部系统选择合适的认证方式。

金蝶云苍穹OpenAPI共支持五种认证方式，分别是：

AccessToken 认证

请求Body参数

请求参数	类型	必传	说明
client_id	String	是	第三方应用系统编码，即appId
client_secret	String	是	第三方应用AccessToken认证密钥，即appSecret
username	String	是	第三方应用代理用户的用户名
accountId	String	是	数据中心id
language	String	否	语言字串： zh_CN，zh_TW、en_US等。默认系统默认语言，查询接口会返回对应的多语言文本字段
nonce	String	是	随机数
timestamp	String	是	时间戳，当前时间前后5分钟

请求参数示例

{
    "client_id": "thirdappunittest_003",
    "client_secret": "Abcdrty@1234567890#@2",
    "username":"zhangSan",
    "accountId": "1355633519610561531",
    "language": "zh_CN",
    "nonce": "123",
    "timestamp": "2023-09-08 11:47:00"
}

返回参数

返回参数	类型	说明
data
- access_token	String	请求令牌，第三方应用调用OpenAPI的凭证
- token_type	String	令牌类型，默认为Bearer，即任何持有token的用户都可以访问对应的资源
- refresh_token	String	刷新令牌，使用refresh_token 去刷新获得新的access_token，只能使用1次
- scope	String	作用域，用户授权给第三方的权限，默认为API
- expires_in	Int	access_token的有效期，即距离过期的剩余时长（单位：毫秒）
- id_token	String	JWT（Json Web Token）
- id_token_expires_in	Int	JWT的有效期，即距离过期的剩余时长（单位：毫秒）
- language	String	浏览器接收语言
errorCode	String	错误码，成功时为0
message	String	错误消息
status	Boolean	请求状态，true/false

返回参数示例

{
"data": {
    "access_token":"OPENAPIAUTH_MTMzMTIwNDQ0NTk5NTc5NDQzMl9FZ3h4MXU1Zzd2Qk9kRjR4MzIxQXZKcXU5c2hpbzNCaTRtTGIzbEsyM3JnbmFJUUJEMEltZUt3UURYQmFFdDJIVnc3MWtyaTVUR01ZbTRDUGVETDVSamE2R0F1a2g5SGpVcmwx",
    "token_type": "Bearer",
    "refresh_token": "d367106c-de46-4fc4-9e1a-59cbcfc430d2",
    "scope": "API",
    "expires_in": "7199977",
    "id_token": "OPE1MGFXMWxJam9pTWpBeU15MHdPQzB5T1NBd01Eb3dNRG93TUM0d0lpd2labVZ1WVdKc1pTSTZJakVpTENKbWRXbGtJam9pTVRNME5qWTNNemtpTENKMWMyVnlWSGx3WlNJNklqRWlMQ0psZUhBaU9qRTJPVFEyTURReU1UZ3NJbWxoZENJNk1UFYTjBaV1FpT2lJeElpd2labkJ6ZDNOMGNtRjBaV2Q1YVdRaU9pSTNOakk1TnpjM09UVTNOekl3TURVek56WWlMQ0oxYzJWeWIzQmxibWxrSWpvaU5XRXlaR1ZtWTJKbE5HSXdPVFUzWm1Fd09HWTRZemN5SWl3aWRYTmxjbTVoYldVaU9pSkpSVkpRSW4wLi1ZZEd1cWhIX25Mcm5ibURnQTlfU2FvQkZsTGJWTTJEUmp2cnR4NXZwckk=",
    "id_token_expires_in": "7199977",
    "language": "zh_CN"
        },
    "errorCode": "0",
    "message": "",
    "status": true
}

错误码说明

错误码	说明
0	请求成功
401	不正确的第三方应用编码client_id或client_secret
603	请求参数错误

Menu

Share

金蝶云苍穹OpenAPI：开发认证指南

1. 简介

2 认证方式

Comment