1.3.1.5 QN.mtop
优质
小牛编辑
125浏览
2023-12-01
1.1. API 调用
1.1.1. QN.mtop(options)
MTOP 接口请求
API 调用入参
| 参数名 | 类型 | 是否可选 | 默认值 | 含义 |
|---|---|---|---|---|
options | Object | 选项 | ||
options.api | String | 请求的 API 名称 | ||
options.v | String | API 版本号 | ||
options.data | Object | optional | 请求的参数 | |
options.appkey | String | optional | H5请求的 appkey ，一般无需提供，有默认值 | |
options.ecode | Number | optional | 是否使用 ecode 签名，需要与服务端 API 约定，1 表示使用，0 表示不使用。默认为 0 | |
options.type | String | optional | GET | 请求类型： GET POST |
options.dataType | String | optional | jsonp | 数据类型：jsonp originaljsonp json |
options.timeout | Number | optional | 发送网络请求的超时时间,默认为 20000 ms | |
options.H5Request | Boolean | optional | 是否强制使用 H5 请求方式进行请求，仅在 Web 页面环境中有效 | |
options.LoginRequest | Boolean | optional | 请求是否要求登陆 | |
options.AntiCreep | Boolean | optional | 请求是否开启防爬 | |
options.AntiFlool | Boolean | optional | 请求是否开启防刷 | |
options.success | Function | optional | 调用成功的回调函数 | |
options.error | Function | optional | 调用失败的回调函数 |
以上仅列出了部分参数，其他相关的参数说明可以查阅：@ali/lib-mtop 或 lib-mtop
API 响应结果
| 参数名 | 类型 | 是否必须返回 | 含义 |
|---|---|---|---|
result | Object | 响应对象 |
调用示例
QN.mtop({
api: 'com.taobao.detail.getTaobaoDyn',
v: '1.0',
data: {itemNumId: 37194529489},
appkey: '12574478',
ecode: 0,
type: 'GET',
dataType: 'jsonp',
timeout: 20000
}).then(result => {
console.log(result);
}, error => {
console.log(error);
});
QN.mtop({
api: 'com.taobao.detail.getTaobaoDyn',
v: '1.0',
data: {itemNumId: 37194529489},
appkey: '12574478',
ecode: 0,
type: 'GET',
dataType: 'jsonp',
timeout: 20000,
success(result) {
console.log(result);
},
error(error) {
console.log(result);
}
});
1.1.2. QN.mtop.setup(options)
MTOP 调用设置
API 调用入参
| 参数名 | 类型 | 是否可选 | 默认值 | 含义 |
|---|---|---|---|---|
options | Object | 选项 | ||
options.prefix | String | optional | mtop 请求域名的前缀，仅在 Web 页面环境中有效 | |
options.subDomain | String | optional | mtop 请求域名的子域，仅在 Web 页面环境中有效 | |
options.mainDomain | String | optional | mtop 请求域名的主域，仅在 Web 页面环境中有效 | |
options.H5Request | Boolean | optional | 是否强制使用 H5 请求方式进行请求，仅在 Web 页面环境中有效 | |
options.LoginRequest | Boolean | optional | 请求是否要求登陆 | |
options.AntiCreep | Boolean | optional | 请求是否开启防爬 | |
options.AntiFlool | Boolean | optional | 请求是否开启防刷 |
以上设置对全局 MTOP 请求都有效，除非在每个请求中再指定选项的值。
调用示例
QN.mtop.setup({
prefix: 'api',
subDomain: 'm',
mainDomain: 'taobao',
H5Request: true,
LoginRequest: true,
AntiCreep: true,
AntiFlool: true,
});