一 基础文档

1.1 平台概况

1.1.1 初识数环通开放平台

数环通开放平台（Solinkup Open Platform）沉淀了数环通业务的基础能力，将数环通的能力对外开放，提供给生态合作伙伴参与服务数环通各类场景，如API、消息推送等。
同时数环通开放平台也为开发者提供大量的商业机会和清晰的盈利模式。如：

• 大量的商业机会： 商家会有多样化需求，无论你是第三方开发者（ISV）、传统软件厂商、行业型网站或者大商家，都能在数环通开放平台上找到合适的业务方向。

• 清晰的盈利模式： 开发者基于开放能力完成应用开发，上架到服务市场，通过服务市场的应用销售分成、软件直接销售收入等获得回报。

1.1.2 了解平台特点

• 业务强大、商机无限：
  数环通依托于各类平台，拥有上亿的潜在用户数，快速增长业务给商家、开发者带来了无限的商机。

• 开放规模大、程度深、限制少：
  数环通开放平台对外开放涵盖了数环通核心流程引擎、业务模板的主要流程，日均API调用量超十万。我们会持续去开放更多的生态能力去服务开发者，帮助开发者实现各类的系统定制。

• 合作形式丰富：
  数环通开放平台是基于各类平台的综合开放平台，我们平台以把业务开放到尽可能多的领域为宗旨。目前，已经为合作伙伴提供了以下的合作形式：商家自用型应用、第三方工具型应用，未来还会开放更多的应用类目，为用户提供多样化的应用。

• 系统安全稳定：
  数环通开放平台是基于OAuth 2.0授权，针对用户数据加密，安全可靠；日均数十万级API调用量、平均延迟低于100ms、系统稳定性高。

1.1.3 深入平台开发

数环通开放平台主要提供两种业务接入模式，软件服务商身份接入模式和商家自研身份接入模式。无论您是第三方开发者（ISV）还是商家，都能基于开放电商开放平台找到适合自己的业务方向。

• 软件服务商接入模式：
  数环通开放平台提供的丰富API涵盖数环通各个核心业务流程，基于这些能力可以为商家提供各类应用，解决各个平台，数据打通等各方面的问题。

• 商家自研接入模式：
  没有开发能力的商家可以在服务市场购买服务商开发的服务，然后直接使用服务进行商家业务经营管理。有一定IT研发能力的商家，可根据自己的定制业务场景，直接入驻平台创建商家自用型应用，然后集成到自己的商家管理系统进行统一业务运营管理，通过对数据进行管理来发掘更多的潜在价值。

1.2 产品功能

1.2.1  入驻流程

1.2.1.1 简介

本文旨在给开发者介绍数环通开放平台的入驻流程

1.2.1.2 注册数环通帐号

1、手机号码（注：如果你是自研商家，请务必使用组织管理人手机号注册）
如何查看组织管理人手机号

2、短信验证码：支持6位短信验证码

点此立即注册

1.2.1.3 购买付费版产品

您可以直接联系在线客服或者销售人员进行开通

1.2.1.4 提交认证信息（暂不需要）

1、开发者需提交的认证信息，规范如下：

• 保证所填写的全部信息真实且与实际信息对应，否则平台会出示审核驳回意见

• 企业名称、注册地址、统一社会信用代码、营业期限、法人代表人姓名、证件号码、证件有效期要与上传的证件照片保持一致，否则平台会出示审核驳回意见

2、相关资质上传要求如下，如若不符，出示审核驳回意见：

• 图片清晰且边框完整

• 提供资质附件如为复印件，须加盖公章

3、开发者提交认证信息后，平台会在10个工作日内进行审核
如若审核不通过，开发者需要重新提交认证信息，重新审核

4、只有认证审核通过后，开发者才能创建应用，如未完成认证时，会有如下图提示：

1.2.1.5 创建应用

1.2.2 授权介绍

1.2.2.1 概述

数环通开放平台工具型应用面向有产品、开发团队，需要为市场上的数环通用户，提供通用或定制的解决方案。申请工具型应用的开发者，应用申请成功后，可以拥有其对应类目的接口使用权限。应用必须上架到数环通服务市场，商家可以在服务市场订购应用并和组织建立授权关系。只有经过商家授权才能进行数据的对接使用，可同时为大量组织提供服务。

1.2.2.2 接入类型介绍

数环通开放平台目前支持Oauth2和ApiSecret两种方式。

• Oauth2授权流程如下所示：

开始 -> ISV服务商：创建应用（接入方式选择Oauth2） -> 商家：订购服务 ->  商家：同意授权 -> ISV服务商：通过code换取token ->  ISV服务商：通过token，openId调用开放api -> 结束

开发者配置

1、开发者在创建工具型应用时，须填写回调地址

2、在「应用后台-应用概览」页面，可查看回调地址，支持编辑修改

注：该回调地址用于接收平台给应用发的授权相关消息和订购相关消息，非接口的消息推送

上架应用（暂不需要）

1、开发测试完成后，开发者可在「应用后台-上架管理」页面，填写应用使用地址，申请应用上架

Tips：

• 应用使用地址会被用来携带code。商家打开授权开关或点击“去使用”按钮，均会打开应用使用地址，并在最后带上code

• 建议填写为对应服务的落地使用页，同时地址参数中能标识数环通来源

2、申请后，会进入上架审核，平台1～3个工作日内会审核完毕

授权
 开发者拼接授权URL，引导商家点击。商家使用组织主账号登录，确定授权

• 应用成功上架后，开发者拼接授权URL

https://www.solinkup.com/workbench/oauth/login?appKey=xx&urlCode=xx&timestamp=xx&method=checkUrlCode&version=1&redirectUrl=yourUrl

Tips：

• 示例中的appKey需要替换成您应用的实际值，可以在【应用后台-应用概览】中可以查看

• timestamp为当前时间戳毫秒数，误差不能超过10分钟

• version目前传1

• urlCode的计算规则为MD5(appKey+appSecret+timestamp)

• redirectUrl传用户授权后需要回调的页面，可以在【应用后台-应用概览】中可以查看

MD5(AppKey@4FF354C41EBF4187BA148E00E3EFED69AppSecret_8083hfh1654487840)

• 引导商家通过浏览器访问以上url，用户登录数环通帐号，点“确认授权”按钮，即可进入授权页面

获取授权code

1、组织确认授权成功后，会自动打开应用使用地址，此时平台会把授权code带到使用地址的url后面。
2、开发者获取到code，并使用该code换取accessToken。

Tips：授权码code有效期为10分钟，有效期内可用来换取accessToken，不限次数；如失效，可以让商家前往【组织后台->授权管理】页面，点击“使用”按钮即可 

获取accessToken

组织同意授权后，使用POST方式请求，使用授权code，可获取accessToken；

https://api.solinkup.com/openapi/oauth2/getAccessToken

0、公共参数
参照其他业务API接口，API接口的公共参数一致

1、业务参数

2、调用示例

{
    "appKey":"AppKey@4FF354C41EBF4187BA148E00E3EFED69",
    "method":"getAccessToken",
    "timestamp":"1651218530319",
    "authCode":"AuthCode@37e0107c183949178853b105b47d85c7",
    "version":"1"
}

3、响应参数

4、响应示例

{
    "requestId": "258dc56f-48b0-469a-8b41-ebd1270d7b80",
    "success": true,
    "code": "__200OK",
    "msgCode": "result.success",
    "message": "执行成功",
    "data": {
        "openId": "OpenId@128D573F0EB6405EAF334A731E31BFF3",
        "accessToken": "AccessToken@3a859c26d23348dc9844acac0a533697",
        "refreshToken": "RefreshToken@BEEC8358E6544FEDA7FB4197ADE3D920",
        "accessTokenExpired": 1651823380704,
        "refreshTokenExpired": 1652428180704
    },
    "pager": null
}

刷新Token

使用上述步骤中获取到的refreshToken，POST方式请求，可获取新的accessToken：

https://api.solinkup.com/openapi/oauth2/refreshAccessToken

0、公共参数
参照其他业务API接口，API接口的公共参数一致

1、请求参数

Tips：

1. 在 accessToken 过期前1h之前，ISV使用 refreshToken 刷新时，会返回原来的 accessToken 和 refreshToken，但是二者有效期不会变；

2. 在 accessToken 过期前1h之内，ISV使用 refreshToken 刷新时，会返回新的 accessToken 和 refreshToken，但是原来的 accessToken 和 refreshToken 继续有效一个小时；

3. 在 accessToken 过期后，ISV使用 refreshToken 刷新时，将获得新的 acces_token 和 refreshToken，同时原来的 acces_token 和 refreshToken 失效；

2、请求示例

{
    "appKey":"AppKey@4FF354C41EBF4187BA148E00E3EFED69",
    "method":"refreshAccessToken",
    "timestamp":"1650615919168",
    "refreshToken": "RefreshToken@BEEC8358E6544FEDA7FB4197ADE3D920",
    "version":"1"
}

3、响应参数

4、响应示例

{
    "requestId": "258dc56f-48b0-469a-8b41-ebd1270d7b80",
    "success": true,
    "code": "__200OK",
    "msgCode": "result.success",
    "message": "执行成功",
    "data": {
        "openId": "OpenId@128D573F0EB6405EAF334A731E31BFF3",
        "accessToken": "AccessToken@3a859c26d23348dc9844acac0a533697",
        "refreshToken": "RefreshToken@BEEC8358E6544FEDA7FB4197ADE3D920",
        "accessTokenExpired": 1651823380704,
        "refreshTokenExpired": 1652428180704
    },
    "pager": null
}

• ApiSecret授权流程如下所示：

开始 -> ISV服务商：创建应用（接入方式选择ApiSecret） -> 商家：订购服务 ->  商家：同意授权 -> ISV服务商：通过用户唯一标识（例如用户手机号）注册数环通帐号 ->  ISV服务商：通过token，openId调用开放api -> 结束

开发者配置

1、开发者在创建工具型应用时，选择接入方式

上架应用（暂不需要）

1、开发测试完成后，开发者可在「应用后台-上架管理」页面，填写应用使用地址，申请应用上架

Tips：

• 应用使用地址会被用来携带code。商家打开授权开关或点击“去使用”按钮，均会打开应用使用地址，并在最后带上code

• 建议填写为对应服务的落地使用页，同时地址参数中能标识数环通来源

2、申请后，会进入上架审核，平台1～3个工作日内会审核完毕

调用开放注册接口

https://api.solinkup.com/openapi/oauth2/registerByOuterId

0、公共参数
参照其他业务API接口，API接口的公共参数一致

1、业务参数

2、调用示例

{
    "appKey":"AppKey@4FF354C41EBF4187BA148E00E3EFED69",
    "method":"registerByOuterId",
    "timestamp":"1651218530319",
    "outerId":"15111901148",
    "outerIdType":"mobile",
    "version":"1"
}

3、响应参数