API接口文档/1. 接口概述
1. 接口概述
API(Application Programming Interface,应用编程接口),简单来说就是把不同的系统通过统一的接口协同一起来完成需求任务,就像USB数据线 一样不管两端连的是什么,都就可以使用。
1.1. 数据传输安全

为保证接口通信中的数据传输安排,本接口规范双方接口通信过程中需遵循以下安全要求

(1)P地址访问授权:即只有经过授权的IP才可以访问采购平台的接口服务;
(2)数据防篡改:进行2次MD5再加双方约定的密钥加密;
(3)访问令牌:由齐心电商平台提供Token(访问令牌),供客户方使用(可不定期或定期更新)。
(4)运行环境:为保证数据安全,服务生产方需提供测试、生产两套环境,以保证测试数据与生产数据安全隔离。
(5)数据安全:由采购平台提交到齐心电商系统的敏感数据(例与用户数据、订单数据等),齐心电商系统严格按照商业数据保密要求,不得泄露给第三方或用作其它用途。因此部分敏感数据采用DES加密算法,具体见接口定义。
(6)接口响应:对于数据读取类接口,要求服务方接口响应时间不超过3秒,对于数据写入类接口,要求服务方接口响应时间不超过4秒。
1.2.数据防篡改算法
MD5:32位大写MD5算法
客户端调用时采用MD5加上双方约定密钥进行两次MD5,生成验签数据,服务端收到消息后采用相同的规则生成验签数据,将其同客户端传入的验签数据进行比较,相同则正常,否则说明被篡改过。
具体规则:MD5(MD5(文档规定的字段)+双方约定密钥)
示例:
MD5(MD5(供应商编号+商品编号+调用时间)+双方约定的密钥)
供应商编号:1000
商品编号:11546742
调用时间:2015-02-26 17:43:22
约定密钥:111111
MD5(MD5(1000115467422015-02-26 17:43:22) +111111)
签名数据:DBD00F67D9160750392C8991E16C970A
1.3. 数据传输安全
为保证接口通信中的数据传输安排,本接口规范双方接口通信过程中需遵循以下安全要求
(1)接口定义中的“服务名称”,即完整的请求URL地址,前面的IP、Port(端口),以及system(系统)、module(模块)可根据供应商的实际情况给定,需要提供测试、生产环境两套URL。URL最后一个斜杠后的字符串,为接口服务方法名,为本规范中约定名称,接口服务的提供方(供应商系统或采购平台)不可以修改。
(2)各接口规范中的头信息(MsgHeader)为接口基本信息部分,头信息节点在JSON中一定存在,实体信息可以有也可以没有,根据具体接口定义确定。
(3)字段属性中的“要求”列,“是”代表为必填字段,“否”代表非必填字段。“数据类型”当为String类型时,其长度根据接口中字段约束长度控制,未约束长度的,实际开发中约定。
(4)本接口规范中未涉及的接口,在对接过程中补充完善。已定义无需使用的接口, 实施中与供应商具体协商。