API-V5 接口说明-海量ADP应用画布接口

海量ADP应用画布接口

3.1 应用画布对外开放接口

POST https://api.hylanda.com/v5/inner_app/custom/{app_name}/{api_name}

测试地址：https://api.hylanda.com/v5/help/util/try/#!/inner95app/InnerApp_CustomApi

接口描述
  • 当用户将海量ADP大数据分析平台中的 ‘应用画布’中的接口对外开放后，会统一映射到此接口中
  • 请注意：仅支持SQL代理接口，不支持对外代理接口
  • 请注意：无法开放使用了“登录信息”的接口（如USER_ID）
接口参数

海量APIv5接口参数统一使用POST JSON 方式传递

参数名 位置 类型 描述 默认值
hl_appkey
必需		 HEADERS string 鉴权用，海量分配的appkey，参考《通用接口标准》
hl_time
必需		 HEADERS string 鉴权用，当前时间，参考《通用接口标准》
hl_sign
必需		 HEADERS string 鉴权用，签名校验码，参考《通用接口标准》
app_name
必需		 URL-PATH string 应用名称，需填写英文名，可在应用访问URL路径中找到
api_name
必需		 URL-PATH string API名称，需填写API英文名称
应用接口参数
必需		 BODY-JSON string 需根据对应的应用接口自行调整
BODY-JSON样例

该接口参数直接对应指定应用接口的参数，需参考其接口参数自行填充参数

{
    "参数名xxx":"参数值xxx",
    "参数名yyy":"参数值yyy",
    "参数名zzz":"参数值zzz"
}
其他参数细节

若该应用接口没有输入参数，BODY-JSON内也需要传输一对大括号 {}

正常响应的返回数据
  • 该接口的返回数据是靠对应的应用接口返回数据决定的
  • 当应用接口返回应用画布标准格式的数据时，该接口仅将返回数据中的 "status" 改为 "res"
  • 否则，该接口会将应用接口返回数据整体放入该样例中的"data"内，再向外输出
{
    "res": 0,
    "msg": "调用完成",
    "data": {}
}

错误返回信息说明

通用错误信息，请参考《通用接口标准》

下面为本服务特有的错误反馈说明

HTTP Code HTTP Response Body Description
200 {
"res": -1,
"msg": "服务器出错：具体错误信息"
}		 服务内部出错，需联系相关人员检查接口逻辑

results matching ""

    No results matching ""