淮安:18505218550
常州:18118028216
淮安地址:淮安市清江浦区颐高广场3号楼工程917室
常州地址:常州市钟楼区怀德南路55号泰盈八千里5-8创新工场二楼
安装
安装并更新补丁包到易助90最新环境,补丁包最低为202505版本
安装包地址:NAS: 2-易助资料库\易助\易助ERP安装包\易助90\安装包
补丁包地址:NAS: 1-Bug程序更新\易助补丁包\YZ90
TPAOpenAPI.exe TPAOpenAPIProcess.exe 也做了加壳处理,需要添加至杀软信任区中,否则会出现误杀导致无法使用。
授权
续购易助OpenAPI授权后,确保易助授权中心升级至9.0.0.42及以上版本
重新查号后,即可看到可用人数。OpenAPI的可用人数和已用人数不会统计至ALL(ERP全系统)模块的人数中。
部署
易助OpenAPI必须和易助ERP环境放在同一目录下,才能正常使用。
运行配置程序
双击打开 易助OpenAPI服务配置程序TPAOpenAPIConfig.exe
基础设置页签
请参考:易助集成接口SmartBusinessServer使用说明 的 三、基础设置 部分
接口设置页签
可以设置接口的json报文节点是否使用可配置的英文,并指定配置账套
区别 | 勾选 | 不勾选 |
Request json | 支持字段(如:DEA001) 支持英文(如:item_no) | 支持字段(如:DEA001) |
Response json | 输出英文(如:item_no) | 输出字段(如:DEA001) |
优点 | 可读性好,可配置 | 无需进行转换处理,速度快 |
运行接口程序
双击打开易助OpenAPI服务程序 TPAOpenAPI.exe
测试
在浏览器中填入地址后显示如下
易助ERP中打开,集成参数,OpenAPI页签
设置授权人员 TPASC19
用于设置授权用户,生成用户的身份令牌
用户身份令牌在接口调用时需要放置于Header中,起到匹配账套,权限管理(包括:开启权限,作业操作权限,数据权限等等完全与ERP一致),默认经办人等一些列与ERP用户登录同样的效果。
当发现接口存在身份令牌泄露的情况时,可以选择点击【重新生成】或者【失效】进行操作
【复制口令】按钮可以将选中的用户身份令牌复制到windows系统剪贴板中,方便复制粘贴使用
配置服务节点 TPASC20
当在易助OpenAPI服务配置程序TPAOpenAPIConfig.exe中,勾选了可使用英文节点
即可通过此作业,进行节点名的自定义设置,以及选定字段设置是否需要隐藏
查看服务列表 TPASC21
开始页签
接口调用地址:填入易助OpenAPI服务配置程序TPAOpenAPIConfig.exe中的Http服务地址
用户身份令牌:填入易助ERP设置授权人员 TPASC19中的用户身份令牌信息
勾选框【请求范例使用英文节点】用于设置测试范例的Request是使用字段名还是易助ERP配置服务节点 TPASC20中的节点名,且需要搭配接口服务配置一同使用
而Response返回的json数据节点是字段名还是英文节点,是通过接口服务配置程序进行管控
【刷新参数】按钮,使用场景为ERP参数设置改变后,通过此按钮可以刷新易助OpenAPI接口缓存的参数设置,无须重启OpenAPI服务。
配置完成后,点击【查看状态】按钮,可以查看接口程序的运行状态,以及接口调用次数,方便运维和分析
弹出窗口表示服务运行正常,否则需要检查配置是否正确。
服务页签
点击左侧树中的业务作业,例如:订单。就可以查看订单的信息包括Service编号,名称,作业编号和可供调用的子服务列表
【复制】按钮可以将文本框中的内容直接复制到windows操作系统剪切板中,方便开发者复制粘贴
【测试】按钮可以将编辑好的Request请求发送给接口服务,并返回结果
【结构】按钮可以将文本框中的json进行结构化展示,方便查看。右侧树形展示,可以点击+/- 号,对json进行展示/收缩操作。
Request请求的文本框可以编辑,在结构窗口中编辑json后点击【确定】按钮可以带回
Response返回的文本框为只读
字段页签
展示了作业的一个基本结构和所有字段信息,用于查询服务、读取服务、新增服务、更新服务json节点的字段对照
【性质】用于标注字段是主键字段、日期字段、计算字段,计算字段为只读字段不可给值
【只读】为DLL作业中设置字段为只读,接口赋值会直接报错
【显示】为DLL作业界面上是否会显示
【必填】为DLL作业检查字段不可为空,不代表接口中必须给值,例如单号等字段程序新增时是会给默认值的,接口新增时,只需要模拟手工录入顺序给特定字段值即可