1、简介
科盛智慧工地建筑工人实名制和工资专用帐户综合信息平台数据开放式接口 OpenAPI 主要为第三方客户端与平台进行数据交互使用;所有 API 均基于 Post 方式请求调用。
2、基本术语
接口提供方(API Provider):接口的定义和实现者,为接口调用方提供接口合法访问的授权。
接口调用方(API Client):接口的调用者,需要从接口提供方获得所需接口合法访问的授权。
接口端点(API Endpoint):接口的Http 资源入口,由一个Http URL 所表示,代表了一个或由参数确定的多个接口的集合。
3、接口调用方式
POST 格式为:```java POST
参数列表
参数列表格式为:参数名1=参数值1&参数名2=参数值2……。
请求标准参数
参数名称 | 参数说明 |
method | 由接口提供方指定的接口标识符。 |
appkey | 项目标识appkey |
timestamp | 调用方时间戳,格式为yyyy-MM-d HH:mm:ss,用于接口提供方判断调用方的时间,通常约定调用请求的时间戳与接口提供方收到请求的时间差在约定的范围内。 |
encrypt | 根据后台提供的项目标识appkey+appsecret+timestamp进行md5加密 |
data | 具体的接口方法中的参数实体信息,(对象需要转换成JSON String) |
- 注意
1、项目的 appkey、appsecret 请从后台管理系统获取。
2、接口请求时只传 appkey 和加密后的校验码,请求请勿传入 appsecret 参数。
生成 MD5 参考网址:https://md5jiami.51240.com/
注意生成的是 32 位 大写的4、接口响应
统一返回参数结构
参数名称
参数说明
code
字符串类型。处理结果编码,200表示成功,其他表示失败
message
处理结果消息
data
接口处理完毕返回的数据(请参见具体接口的返回信息)
标准code 代码定义。字符串类型: 200: 正确
-1: 请求参数错误 -2: 签名校验错误 -3: 无API 访问权限 -4: IP 校验错误 -5: 访问超过限制
注:标准错误码小于 0,大于 0 的错误码由各接口根据接口语义自行定义5、敏感信息 AES 加密
敏感信息(身份证号,银行卡号等)需要加密传输,请使用 AES 加密,算法说明:
算法密钥=接入密钥 KEY, 编码=UTF8, 加密模式(CipherMode)=CBC, 填充模式(PaddingMode)=PKCS7, 数据块大小(BlockSize)=128, 算法的初始化向量(IV)= 接入密钥 KEY 的前 16 位字符,6
加密后的字节数组转为 Base64 字符串,需要加密的字段会在字段备注中添加'AES'标记。 算法:密文=Base64(AES(info, KEY))。
- 注意 1、AES 中的 KEY 即为项目对应的 appsecret。
例 如 : KEY 为 252b879532d147c5 , info 为 123 AES 加 密 后 为 : YnnDFjITLTtSCKO0IuASPw==
6、环境地址
测试
{+}http://172.16.1.23:9999/zhgd+![]()
正式
淮安实名制
{+}http://smz.jsske.cn:23000/zhgd+![]()