淘宝开放平台

登录
文档中心 > API类目 > 营销API

营销API

alipay.marketing.tool.fengdie.editor.query (唤起凤蝶H5应用的编辑器)

根据H5应用id唤起编辑器

公共参数

请求地址：
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数：
参数 类型 是否必填 最大长度 描述 示例值
app_id String 是 32 支付宝分配给开发者的应用ID 2014072300007148
method String 是 128 接口名称 alipay.marketing.tool.fengdie.editor.query
format String 否 40 仅支持JSON JSON
charset String 是 10 请求使用的编码格式，如utf-8,gbk,gb2312等 utf-8
sign_type String 是 10 商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2 RSA2
sign String 是 256 商户请求参数的签名串，详见签名 详见示例
timestamp String 是 19 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 是 3 调用的接口版本，固定为：1.0 1.0
app_auth_token String 否 40 详见应用授权概述
biz_content String 是 - 请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
activity_id Number 必须 11 凤蝶H5应用唯一id，通过alipay.marketing.tool.fengdie.activity.create接口时自动生成 100
redirect_url String 必须 500 在凤蝶编辑器中点击“发布”按钮后，如果发布成功则跳转到该地址 https://open.alipay.com/activity/callback

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String 是 - 网关返回码,详见文档 40004
msg String 是 - 网关返回码描述,详见文档 Business Failed
sub_code String 否 - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String 否 - 业务返回码描述,详见文档 交易已被支付
sign String 是 - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
url String 必填 500 凤蝶编辑器访问地址，可通过iframe集成在后台系统，由系统用户编辑H5应用内容。url的有效期为15秒，因此每次需要编辑h5页面的时候应该重新调用Api生成。 https://fengdie.alipay-eco.com/open/editor/100?redirect_url=https%3A%2F%2Fopen.alipay.com%2Factivity%2Fcallback

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
1
2
3
4
5
6
7
8
9
10
11
12
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingToolFengdieEditorQueryRequest request = new AlipayMarketingToolFengdieEditorQueryRequest();
request.setBizContent("{" +
"\"activity_id\":100," +
"\"redirect_url\":\"https://open.alipay.com/activity/callback\"" +
"  }");
AlipayMarketingToolFengdieEditorQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
1
2
3
4
5
6
7
8
{
    "alipay_marketing_tool_fengdie_editor_query_response":{
        "msg":"Success",
        "code":"10000",
        "url":"https://fengdie.alipay-eco.com/open/editor/100?redirect_url=https%3A%2F%2Fopen.alipay.com%2Factivity%2Fcallback"
    },
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

  • JSON示例
1
2
3
4
5
6
7
8
9
{
    "alipay_marketing_tool_fengdie_editor_query_response":{
        "msg":"Service Currently Unavailable",
        "code":"20000",
        "sub_msg":"系统繁忙",
        "sub_code":"isp.unknow-error"
    },
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码 错误描述 解决方案
ACTIVITY_NOT_EXIST H5页面不存在 请确认activity_id对应的H5页面是否存在，及是否有访问权限。
ACTIVITY_REDIRECT_URL_NOT_EXIST H5页面发布后的跳转地址不存在 redirect_url是必选参数不能忽略

公共错误码

公共错误码
有用(2)
我要提问
返回
顶部