服务端

公共请求头

在Http Request Header中配置以下参数

注:

• x-adm-ts 有效期：出于安全性考虑，每个 x-adm-ts 的有效期为 5 分钟(用 x-adm-ts 计算)，同时 x-adm-ts 要与标准时间同步，否则时间相差太大，服务端会直接认为 x-adm-ts 无效；

公共返回格式

Http响应统一采用JSON格式, 格式如下

返回值状态码

注:

• 服务端请根据状态码自定义操作逻辑, 建议不要把开放API的message直接返回给客户端

签名介绍

1. 把x-adm-appid, x-adm-once, x-adm-ts的请求头字段和值放入集合中, 根据ASCII编码排序
2. 把排序后的集合进行键值对拼接, 得到head1=value1&header2=value&head3=value3, 记为stringToSign
3. 把stringToSign 拼接APP密钥, 该密钥在开发者后台提供
4. 把最终的stringToSign进行MD5大写输出, 即得到签名值, 把改签名值放入请求头x-adm-sign

代码示例:

SortedMap<String, String> sortedMap = new TreeMap<>();
sortedMap.put(HttpRequestHeader.appId, request.getHeader(HttpRequestHeader.appId));
sortedMap.put(HttpRequestHeader.once, request.getHeader(HttpRequestHeader.once));
sortedMap.put(HttpRequestHeader.timeStamp, request.getHeader(HttpRequestHeader.timeStamp));

StringBuilder sb = new StringBuilder();
for (String key : sortedMap.keySet()) {
    Object value = sortedMap.get(key);
    if (value == null) {
        continue;
    }
    if (sb.length() > 0) {
        sb.append("&");
    }
    String valueString = String.valueOf(value);
    sb.append(key).append("=").append(valueString);
}
sb.append(secret);
return DigestUtils.md5Hex(sb.toString()).toUpperCase();

接口列表

获取手机号

http://open.yuyan.admobile.top/api/getMobile [POST, application/json]

请求Json参数:

返回值

GetMobileResult

校验手机号

http://open.yuyan.admobile.top/api/verifyMobile [POST, application/json]

请求Json参数:

返回值

VerifyMobileResult