# Http 网络请求

• 方法
  • request 发起网络请求
  • doCancel 取消网络请求

# request

发起网络请求

• 支持平台

  Android	IOS	HarmonyOS
  √	√	√

• 参数说明

  参数名	类型	必填	说明
  data	httpData	是	网络请求参数，详见下表
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  url	string	是	服务器接口地址
  parameter	object	可选	请求参数
  header	object	可选	网络请求请求头参数，不能设置 Referer
  Content-Type	String	可选	支持两种application/json 默认(我们网关默认Content-Type)；application/x-www-form-urlencoded (外部请求较常用)
  consult	String	可选	"1"表示要协商工作密钥，走我们网关的请求都需要有工作密钥，工作密钥协商一般放在登录/注册接口
  method	string	可选	必须大写，默认GET,支持GET, POST, HEAD, DELETE, PUT, PATCH
  timeout	Number	可选	超时时间 默认30, 单位：秒
  sslVerify	Boolean	可选	是否验证 ssl 证书，默认true
  isEncrypt	string	可选	是否对报文体加密,只针对post请求，对body体加密 值为:"1",则对用工作密钥对报文体加密,加密后替换body体。默认不加密。
  outSide	string	可选	区分我们的网关请求和普通请求 默认值"0"，"0"表示走我们网关的那套逻辑，"1"表示为外部请求，当做普通请求处理,不走签名和加密那套体系

• completedCB返回参数说明

  参数名	类型	说明
  status	string	调用状态码
  message	string	调用结果信息
  payload	Object	接口调用结果，结果参考下表

• payload调用结果说明

  参数名	类型	说明
  statusCode	String	开发者服务器返回的 HTTP 状态码
  data	Object	code码成功返回的数据
  header	Object	开发者服务器返回的 HTTP Response Header，K-V形式

• 注意 桥失败，则请求不会发出，此时payload无值，会有对应桥错误码在status。 50002 工作密钥为空 当设置需要加密，且不是协商工作密钥接口。报此错误

• 示例代码

var params = {
    url : 'https://api.apiopen.top/searchMusic',
    method : 'POST',
    parameter : {
        'page':'1',
        'size':'10',
        'condition':{}
    },
    header : {
        'Content-Type': 'application/json',
        'X-requested-With': 'XMLHttpRequest',
        'Authorization': 'Basic d2ViX2FwcDo=' // 业务TOKEN
    },
    timeout: 20,
    sslVerify : false
}
foxsdk.http.request(params, ret => {
    console.log('bindCallNative===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
})

# doCancel

取消网络请求(IOS系统不支持)

• 支持平台

  Android	IOS	HarmonyOS
  √	×	×

• 参数说明

  参数名	类型	必填	说明
  url	String	是	网络请求TAG值，建议: 与服务器接口地址(url)一致
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	String	调用状态码
  message	String	调用结果信息
  payload	Object	不需要返回取消状态数据

• 示例代码

foxsdk.http.doCancel({url:'https://api.apiopen.top/searchMusic'}, ret => {
    console.log('docancel===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
})