文档中心 > API类目 > miniapp开放API

taobao.miniapp.template.instantiate (构建实例化应用)

实例化saas化的小程序

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
clients String [] 必须 taobao
  • 最大列表长度:20
  • 投放端,目前可投放: taobao(淘宝),tmall(天猫),taobao为必填,需要模板在这些端上已经发布上线
    description String 必须 描述字数需要符合要求 描述长度(9~200)
    ext_json String 必须 { "name":"test"} 扩展信息,JSON格式。
    icon String 必须 http://xxx.png 小程序icon
    name String 可选 小程序名称 小程序名称按平台规则自动生成,该字段仅做兜底使用。
    template_id String 必须 123 模板id
    template_version String 必须 0.0.1 模板版本
    alias String 可选 小程序简称 小程序简称【1-16】字符,可重名

    响应参数

    名称 类型 示例值 描述
    appkey String 123 appkey
    app_id String 1 小程序app_id
    app_name String 店铺名_模板名 小程序名称按平台规则自动生成。在授权弹窗标题、「关于」页面展示名称。
    app_description String 小程序描述 小程序描述
    app_icon String icon 小程序icon
    app_version String 0.0.1 当前新生成的预览版本号
    pre_view_url String http://xxx 当前新生成的预览版本的链接,仅当前商家有权限预览。
    app_alias String 我的简称 小程序简称。在小程序Loading动画、首页标题、「更多」菜单标题上优先展示简称。

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    MiniappTemplateInstantiateRequest req = new MiniappTemplateInstantiateRequest();
    req.setClients("taobao");
    req.setDescription("描述字数需要符合要求");
    req.setExtJson("{ \"name\":\"test\"}");
    req.setIcon("http://xxx.png");
    req.setName("小程序名称");
    req.setTemplateId("123");
    req.setTemplateVersion("0.0.1");
    req.setAlias("小程序简称");
    MiniappTemplateInstantiateResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <miniapp_template_instantiate_response>
        <appkey>123</appkey>
        <app_id>1</app_id>
        <app_name>店铺名_模板名</app_name>
        <app_description>小程序描述</app_description>
        <app_icon>icon</app_icon>
        <app_version>0.0.1</app_version>
        <pre_view_url>http://xxx</pre_view_url>
        <app_alias>我的简称</app_alias>
    </miniapp_template_instantiate_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案
    2913 参数不合法 根据文档检查参数
    2912 模板所在解决方案未上架 先到控制台上线解决方案
    2903 模板对应端或版本不存在 检查模板在当前端上是否已发布
    2921 taobao端为必传参数 taobao端为必传参数
    2910 当前开发者或商家没有入驻 入驻商家应用
    2905 没有权限实例化当前模板id, 请建立购买操作后再实例化 购买后才能实例化
    2908 创建小程序失败 联系技术支持
    2900 内部错误 遇到该错误码请联系平台技术支持
    2901 实例化的模板不存在 先创建模板并上线后再进行实例化操作
    2904 获取用户信息失败 检查商家账号正确性
    2926 名称已经存在 名称已经存在,请根据实际情况更换名称字段值

    API工具

    如何获得此API

    FAQ

    返回
    顶部