Introduction

概述

关于柠檬云

柠檬云财税是中国领先的SASS软件厂商，立志为中国用户提供功能强大、简洁好用的云财务软件。我们欢迎任何第三方系统与柠檬云财税集成，您可以根据您的实际情况选择您希望的集成模式。

如何注册为柠檬云第三方

您可以使用以下方式

联系商务合作
联系官网客服

为什么成为柠檬云合作方

无缝集成

可以免费使柠檬云相关的业务系统（记账，进销存，代账）内嵌到您的应用中

定制开发

我们可以根据您的需求做部分定制开发，以便灵活的使用我们的系统

嵌入方式灵活

柠檬云提供页面嵌入方式或接口直接调用
页面嵌入方式可以使得柠檬云快速赋能您的应用，在页面中快速使用记账或进销存等业务系统
接口调用方式使得您可以为用户提前做好准备，可以将您的业务能力赋给柠檬云使得业务系统交互变得简单高效，提升用户体验

信息安全

如果您浏览完整个文档后，您会发现，柠檬云为第三方系统提供了很大的权限。对于第三方系统自己创建的用户账号和用户数据，第三方系统有完全的访问权限和操作权限。如果您集成了柠檬云的页面，而且在您系统中也没有添加柠檬云的链接，那么用户是完全感觉不到这是另外一个系统，就好像在一个系统中一样。即使有链接可以链到柠檬云系统，但如果您使用与您系统的登录密码不一样的密码来初始化柠檬云的账号和密码，那么由于用户并不知道该密码，用户只能从第三方系统中点击链接来访问柠檬云网页。柠檬云为第三方厂商提供了很大的权限，是为了更深度的无缝集成，从而达到更好的用户体验。如果第三方系统没有很好的保存用户登录柠檬云的密码，或者该密码是明文存放的，那么存在用户数据被泄露的风险。所以我们希望所有的第三方厂商都能够注意信息安全，保障好用户的数据，即使是您自己的工程师也应该不能够轻易访问用户的数据。

全局公共参数

生产环境

参数名称	参数值	说明
$ACCOUNTOPEN_HOST	https://open2.ningmengyun.com	第三方开放账号接口地址
$ACCOUNTPC_HOST	https://api.ningmengyun.com	token 获取cookie
$ACCAPI_HOST	https://open2.ningmengyun.com	记账系统接口地址
$ACCPAGE_HOST	https://j6.ningmengyun.com	记账系统页面地址
$SCMAPI_HOST	https://jxcapi.ningmengyun.com	进销存系统接口地址
$SCM_HOST	https://jxc.ningmengyun.com	进销存嵌入页面脚本地址
$DZAPI_HOST	https://dzapi.ningmengyun.com	代账系统接口地址
$DZ_HOST	https://dz.ningmengyun.com	代账嵌入页面脚本地址

测试环境

参数名称	参数值	说明
$ACCOUNTOPEN_HOST	http://open2test.ningmengyun.com	第三方开放账号接口地址
$ACCOUNTPC_HOST	http://apitest.ningmengyun.com	token 获取cookie
$ACCAPI_HOST	http://open2test.ningmengyun.com	记账系统接口地址
$ACCPAGE_HOST	https://jh5test.ningmengyun.com/	记账系统页面地址
$SCMAPI_HOST	http://scmtestapi.ningmengyun.com	进销存系统接口地址
$SCM_HOST	http://scmtest.ningmengyun.com	进销存嵌入页面脚本地址
$DZAPI_HOST	http://aatestapi.ningmengyun.com	代账系统接口地址
$DZ_HOST	http://aatest2.ningmengyun.com	代账嵌入页面脚本地址

开发前必读

接口列表阅读说明

所有的接口需使用HTTPS协议、JSON数据格式、UTF8编码。接口说明格式如下：

请求地址：GET/POST https://open2test.ningmengyun.com/api/Cashier/Transfer/GetTransferList?dateS=DATES&dateE=DATEE 请求头说明： ... 请求参数说明： ... 返回值说明： ... 返回示例： ...

1）请求地址，标明接口调用的HTTP方法，区分HttpGet/HttpPost请求。所有的请求都为https协议。参数中标注大写的单词，表示为需要替换的变量。在上面的例子中 DATES 及 DATEE 为需要替换的变量，根据实际获取值更新。假如，这里我们获取到的DATES=2022-01-01，DATEE=2022-12-31，那么上述的请求在发送时为：

GET/POST https://open2test.ningmengyun.com/api/Cashier/Transfer/GetTransferList?dateS=2022-01-01&dateE=2022-12-31

2）请求头说明，接口描述中若带有请求头说明，表示该接口需要携带 Token 信息，并通过请求头传递：

key: Authorization value: Bearer ar459Tk8h8X0PY9YIJmhJoLwLI6i903J2F-NJ--GjyjSF03i4MlqGxSD_rkFwi0Zb9IjO71zvejjlvV55m2FfZebZa5UErROWxH8nPxNJMosI_7R3D-DZNxhQUZuZmOYm0OOhwp6Aqn7gVPM72TVs3Xj87_jP3F7ZXCt8tPgAOR-U5w-ZSKGmOqbCvs0pFnSCEmKjCKhmoYhPTLEGd63fNNA_n3SlHNim7aZ1BC1FndYu5AjYzBlOWxD66GYzs-IWNiFk9s9pSuJzP-rdzv8exFKRgCSY2sTcyXD26g4RZlnSK0l4bEa-DW0ttQeeGKSEN17LWgfZv78dCCcMg-xioBI52dPF9UPRWJfjLHG8ho

3）请求参数说明，请求参数中以表格的形式列出了所有需要传递的参数，请求参数的传递分为以下几种情况：

//1. 未列出请求参数：则不需要传递。可参考账套管理接口 //2. 全部请求参数均以 QueryString 形式出现在url中，则设置好url参数即可如上文中的GetTransferList接口 //3. 全部请求参数需要以 application/json 的形式传递的情况：（注意args不需要传递，只需要传递其下的属性即可）可参考GetBusinessActivitySheets接口 //4. 上文中2，3共存的情况：（注意args不需要传递，只需要传递其下的属性即可）可参考GetCashFlowSheet接口

3）返回值说明，所有接口均返回一个 json 对象，且均包含以下属性：

State：//返回值状态，它只有三种情况：1000， 2000， 9999，具体描述如下 //1. 返回1000时，表示接口调用成功，不需要关心其它属性 //2. 返回2000时，表示接口调用成功，但执行结果失败，需要关注 Msg 内容 //3. 返回9999时，表示接口调用失败，需要关注 Msg 内容 SubState：//返回值子状态 //该字段目前可忽略 Msg：//返回信息描述 //当 Stage 未返回 1000 时，可查看该属性获取具体信息 Data：//额外携带的数据 //当 Stage 返回 1000 时，Data 会带有额外的数据，具体可参考接口列表中每个接口的返回值部分的说明

4）返回值说明，返回了该接口返回的对象的全部属性，以及内部组合的对象或集合类型属性聚合对象的内部属性

页面嵌入说明

您需要使用 iframe 进行页面嵌套，可以参考示例中的代码

被嵌套的页面在进行了一些业务操作后，可能会对父页面进行事件通知，目前提供了 postMessage方式来发送通知，详细使用过程可以参考页面嵌入里的实现事件通知