Getting Started

引入JS文件#

JS API使用约定#

{
    param1: 'xxx',  // 接口参数1（示例）
    ...
    paramn: 'xxx',  // 接口参数n（示例）
    onSuccess: function(resp) {
        // 成功回调处理...
    },
    onFail: function(error) {
        // 失败回调处理...
    }
}

{
    result1: 'xxx',  // 返回参数1（示例）
    ...
    resultn: 'xxx',  // 返回参数n（示例）
}

{
    errorCode: 40000, // 错误码
    errorMessage: '请求参数错误'  // 错误描述
}

初始化API运行环境#

signature签名算法

jsapi_ticket#

jsapi_ticket是纷享应用调用纷享JS API的临时票据，在签名计算中使用。正常情况下，jsapi_ticket的有效期为7200秒，通过corpAccessToken来获取。详情参考获取jsapi_ticket。
为提高性能，且避免频繁刷新jsapi_ticket导致api调用受限，影响自身业务，开发者必须在自己的服务全局缓存jsapi_ticket 。

签名算法#

签名生成规则如下：参与签名的字段包括noncestr（随机字符串）, 有效的jsapi_ticket, timestamp（时间戳）, url（当前网页的URL，不包含#及其后面部分） 。对所有待签名参数按照字段名的ASCII 码从小到大排序（字典序）后，使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串src_string，参数名均为小写字符，字段名和字段值都采用原始值，不进行URL转义。最后对src_string作sha1加密，即signature=sha1(src_string)。

示例：

// 各计算因子声明
jsapi_ticket=abc123456789
noncestr=randxxxx
timestamp=123456
url=https://www.fxiaoke.com/s?ie=utf8&wd=broker&tn=87048150_dg

// 拼接出src_string。对所有待签名参数按照字段名的ASCII 码从小到大排序（字典序），顺序依次为 jsapi_ticket，noncestr，timestamp，url，用&拼接其键值对。
jsapi_ticket=abc123456789&noncestr=randxxxx&timestamp=123456&url=https://www.fxiaoke.com/s?ie=utf8&wd=broker&tn=87048150_dg

// 对src_string进行sha1签名，得到signature（大小写敏感，需要全部转为大写）
784E655546BCEC2D5B8392B5998FE1403B6DD0DA

Java 示例：

public String jsapiSign(Map<String, String> signMap){
    String resultSign = null;
    try{
        Map<String, String> treeMap = new TreeMap(signMap);
        StringBuilder sb = null;
        Set<String> keySet = treeMap.keySet();
        Iterator<String> iter = keySet.iterator();
        while (iter.hasNext()) {
            String key = iter.next();
            if(sb == null){
                sb = new StringBuilder();
                sb.append(key).append("=").append(treeMap.get(key));
            } else {
                sb.append("&").append(key).append("=").append(treeMap.get(key));
            }
        }
        MessageDigest sha1 = MessageDigest.getInstance("SHA-1");
        byte[] digest = sha1.digest(sb.toString().getBytes());
        resultSign = parseByte2HexStr(digest);

    } catch (Exception e) {
        logger.error("calcSign error signMap:{}, exception, ", signMap, e);
        return null;
    }
    return resultSign;
}
public static String parseByte2HexStr(byte buf[]) {
    StringBuffer sb = new StringBuffer();
    for (int i = 0; i < buf.length; i++) {
        String hex = Integer.toHexString(buf[i] & 0xFF);
        if (hex.length() == 1) {
            hex = '0' + hex;
        }
        sb.append(hex.toUpperCase());
    }
    return sb.toString();
}

注意事项

1.

签名用的noncestr和timestamp必须与FSOpen.init中的nonceStr和timestamp相同。

2.

签名用的url必须是调用JS接口页面的完整URL，但不包含#及其后面部分。

3.

出于安全考虑，请务必在服务器端实现签名的逻辑。

4.

上述案例中的各参数取值以及计算结果均为标准算法实际运行结果，开发者可用其检验自己的算法实现。

返回说明#

样例#