API Reference
English

Web&H5

初始化SDK

将以下代码嵌入关键业务入口页面的 head 标签内

<script type="text/javascript">
	(function(){
		window._fmOpt = {
			partner: 'your partner',
			interfaceProtection: true
		};
		var fm = document.createElement('script'); 
        fm.type = 'text/javascript'; fm.async = true;
		fm.src = 'Base URL' + '?t=' + (new Date().getTime()/3600000).toFixed(0);
        var s = document.getElementsByTagName('script')[0]; 
        s.parentNode.insertBefore(fm, s);
	})();
</script>

Base URL 获取

1.创建Base URL

2.复制Base URL

window._fmOpt 配置参数

参数名类型描述备注示例是否必传
partnerString合作方名称由TD分配,请勿随意更改(只能字母、数字、下划线组合)"demo"
interfaceProtectionBoolean是否开启接口保护true:开启
false:不开启 (默认)
true

接口签名

注意:我们不会记录和使用您的请求参数,同时推荐接入方将自己的请求参数摘要处理后以body的方式传给SDK

if(_fmOpt.sign){
  var fingalsign = _fmOpt.sign({
    path:'', // 仅支持字符串类型
    query:{},// 对象类型,请确保KV值中的V为字符串类型
    body:'',// 仅支持字符串类型
  })
  if(fingalsign.code == 0) {
    // 获取签名并使用
    var sign = fingalsign.sign // 最终的sign值
  } else {
    // 获取错误信息和状态码
    var msg = fingalsign.msg
    // 继续业务逻辑,此处签名可以用空字符替代
    var errcode = fingalsign.code
  }
}else {
  // 接口保护未初始化
}

参数说明:

假设针对 https://baidu.com/user/profile?name=jacy&type=2 做接口保护,示例值可参考:

参数名类型示例&&说明
path字符串'user/profile'
query对象,且KV值中的V为字符串类型{name:'jacy',type:'2'}
body字符串query和body上传一个即可,对应参数值不是对象类型时可使用body

状态码:

codemsg补充说明
0success成功
2000failed, path is emptypath为空,请传入对应path
2002path is not a stringpath 必须是字符串
2003query is not a objectquery 必须是对象
2004body is not a stringbody 必须是字符串
2201The value values of query are not all stringsquery中value不全是字符串
3001not supported不支持
3002initialization failed初始化失败
3003sign failed加签失败