基于AK和SK认证鉴权OpenAPI
v3.8.1+支持本文介绍了基于安全认证Access Key/Secret Key鉴权，HTTP调用API的流程。
应用场景：通过AK/SK的方式来调用API接口，主要用于第三方系统对接，避免了token的复杂性和安全性问题。
API 调用流程简介
基于安全认证AK/SK进行鉴权，调用API流程如下图所示。
- 创建安全认证的AK/SK账号。获取安全认证Access Key（即AK）、Secret Key（即SK）。
- 接口配置并授权，通过平台配置接口，并将接口授权给AK/SK账号。
- 生成鉴权签名signature。根据签名算法生成鉴权信息signature。
- 调用API接口。
API 调用流程
步骤一：API授权
在系统中创建OpenAPI接口配置，并将接口授权给指定的AK/SK账号。只有被授权的接口才允许调用，否则将被拒绝。
步骤二：获取安全认证AK/SK
在系统中获取安全认证的 Access Key（AK）和 Secret Key（SK），用于后续生成签名。
步骤三：生成用于鉴权的认证字符串signature
调用OpenAPI时，需要在请求头中添加以下三个参数：
| 请求头 | 说明 | 示例 |
|---|---|---|
appkey | 授权的AK（appkey） | ak-r2nbujSB6SKwUp42 |
timestamp | 当前时间戳（毫秒） | 1710000000000 |
signature | 签名字符串，算法为 md5(appkey + sk + timestamp) | e10adc3949ba59abbe56e057f20f883e |
调用地址格式：{baseUrl}/openapi/call/{path}?参数...
返回结果格式：
| 字段 | 说明 |
|---|---|
code | 状态码 |
message | 提示信息 |
result | 接口返回的业务数据 |
success | 是否成功（true/false） |
timestamp | 时间戳 |
查看OpenAPI可调用接口，启动jeecg后，访问swagger地址，找到OpenAPI组即可。
通过单元测试调用OpenAPI示例
package org.jeecg.modules.openapi.test;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.junit.jupiter.api.Test;
import java.security.MessageDigest;
/**
* OpenAPI 开放接口调用示例
*
* 调用地址: {baseUrl}/openapi/call/{path}?参数...
* 请求头: appkey, signature, timestamp
* 签名算法: signature = MD5(appkey + sk + timestamp)
*/
public class SampleOpenApiTest {
private final String base_url = "http://localhost:8080/jeecg-boot";
private final String appKey = "ak-r2nbujSB6SKwUp42";
private final String searchKey = "XpZpRzlwVBBrEiyIwS5FdRQPGQZsMxJw";
@Test
public void test() throws Exception {
// 根据部门ID查询用户
String url = base_url+"/openapi/call/TEwcXBlr?id=c6d7cb4deeac411cb3384b1b31278596";
JSONObject header = genTimestampAndSignature();
HttpGet httpGet = new HttpGet(url);
// 设置请求头
httpGet.setHeader("Content-Type", "application/json");
httpGet.setHeader("appkey",appKey);
httpGet.setHeader("signature",header.get("signature").toString());
httpGet.setHeader("timestamp",header.get("timestamp").toString());
try (CloseableHttpClient httpClient = HttpClients.createDefault();
CloseableHttpResponse response = httpClient.execute(httpGet);) {
// 获取响应状态码
int statusCode = response.getStatusLine().getStatusCode();
System.out.println("[debug] 响应状态码: " + statusCode);
HttpEntity entity = response.getEntity();
System.out.println(entity);
// 获取响应内容
String responseBody = EntityUtils.toString(response.getEntity());
System.out.println("[debug] 响应内容: " + responseBody);
// 解析JSON响应
JSONObject res = JSON.parseObject(responseBody);
//错误日志判断
if(res.containsKey("success")){
Boolean success = res.getBoolean("success");
if(success){
System.out.println("[info] 调用成功： " + res.toJSONString());
}else{
System.out.println("[error] 调用失败： " + res.getString("message"));
}
}else{
System.out.println("[error] 调用失败： " + res.getString("message"));
}
}
}
/**
* 生成 timestamp 和 signature
*/
private JSONObject genTimestampAndSignature(){
JSONObject jsonObject = new JSONObject();
long timestamp = System.currentTimeMillis();
jsonObject.put("timestamp",timestamp);
jsonObject.put("signature", md5(appKey + searchKey + timestamp));
return jsonObject;
}
protected String md5(String sourceStr) {
String result = "";
try {
MessageDigest md = MessageDigest.getInstance("MD5");
md.update(sourceStr.getBytes("utf-8"));
byte[] hash = md.digest();
int i;
StringBuffer buf = new StringBuffer(32);
for (int offset = 0; offset < hash.length; offset++) {
i = hash[offset];
if (i < 0) {
i += 256;
}
if (i < 16) {
buf.append("0");
}
buf.append(Integer.toHexString(i));
}
result = buf.toString();
} catch (Exception e) {
throw new RuntimeException("sign签名错误", e);
}
return result;
}
}
通过Postman调用OpenAPI示例
- header（必须项）
- 参数（可选项）
