Call3rdAPI
≥4.8.1
接口功能
转发web请求,针对第三方API 跨域限制解决方案
请求参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
APIName | string | true | AppMaker平台中注册第三方API时设置的API Name |
Parameters | Dictionary<string, object> |
false | 请求第三方API的参数 |
[info] 提示
- Parameters 支持根据 POST 和 GET 请求方式自动追加
- vProfile 的接口参数中不需要设置 APIAccess
- 非vProfile接口有30秒超时限制
- 注册第三方API步骤请参考:注册第三方API
- 如果注册接口时开启了Append Userinfo,则第三方接口可以从request header中取得以下信息:
- 用户信息定义(包括加号):[tenant]+[appCode]+[staffCode]
- header key:User,UICC
- UICC:用户信息校验码,用来校验staff code是否被篡改
- UICC计算方式:MD5({api.SecurityToken}{userInfo}{userInfo}{api.SecurityToken}),32位大写
返回数据类型
string
输入示例
{
"APIName": "3rdAPI-demo",
"Parameters": {
"3rdAPIParameter1": "param-example",
"3rdAPIParameter2": "1191c1e6212442d48b21b6e50ebc937a"
}
}
返回类型
- statusCode:调用 CallAPI 的状态,200表示调用成功
- Info:调用 CallAPI 的信息,出现错误时供开发者查看可读原因
- Data:第三方接口返回内容,response content 被序列化后的值
返回示例
{
"StatusCode": 200,
"Info": "Request (or process) succeeded",
"Data": "3rdAPI result"
}