ScriptTag - 友好速搭 -- 使用手册

友好速搭

开放 API
使用说明 获取授权 全部 API 特殊 API 开放功能

ScriptTag

ScriptTag

ScriptTag 可用于在店面主题中,加载指定的javascript资源,从而实现动态控制店铺页面,而无需修改主题。

ScriptTag 有两个主要属性:

  • src:脚本的URL
  • event:触发DOM下载脚本的事件,当前只支持onload

应用只能操作自己创建的 ScriptTag,当应用被从店铺移除时,其创建的所有ScriptTag会被同步移除。

ScriptTag 相关API

GET /script_tags获取应用创建的所有 ScriptTagGET /script_tags/count获取应用创建 ScriptTag 总数目GET /script_tags/#{id}获取指定 ID 的 ScriptTagPOST /script_tags创建一个新的 ScriptTagPUT /script_tags/#{id}修改指定 ID 的 ScriptTagDELETE /script_tags/#{id}删除指定 ID 的 ScriptTag

ScriptTag 属性

    • id
    •   { "id" : 2 }
      
      Number 类型,ScriptTag 唯一整型标识。
    • event
    •   { "event" : "onload" }
      
      String 类型,DOM 中触发加载脚本的事件,仅支持onload
    • src
    •   { "src" : "//dfdfd.com/ddd.js" }
      
      String 类型,脚本加载网址。
    • created_at
    •   { "created_at" : "2015-03-12T15:35:12.242+08:00" }
      
      Datetime 类型,ScriptTag 的创建时间。
    • updated_at
    •   { "updated_at" : "2015-03-12T16:18:21.602+08:00" }
      
      Datetime 类型,上次更新 ScriptTag 的时间。

GET /script_tags

获取应用创建的所有 ScriptTag

    • limit
    • 返回结果条数
      默认10,最大50
    • page
    • 显示的页码
      默认1
    • since_id
    • 返回大于指定ID的结果
    • src
    • 获取指定URL的结果
    • fields
    • 只返回指定的字段
      多个字段用,间隔
    • 获取在店铺中创建的 ScriptTag 列表
    • GET /script_tags
    • {
      "script_tags": [
          {
              "created_at": "2015-03-12T15:35:12.242+08:00",
              "event": "onload",
              "id": 2,
              "src": "//dfdfd.com/ddd.js",
              "updated_at": "2015-03-12T15:39:41.693+08:00"
          },
          {
              "created_at": "2015-03-12T16:18:21.602+08:00",
              "event": "onload",
              "id": 3,
              "src": "http://baidu.com/dd.js",
              "updated_at": "2015-03-12T16:18:21.602+08:00"
          }
      ]
      }
      
    • 获取指定网址的 ScriptTag
    • GET /script_tags?src=//dfdfd.com/ddd.js
    • {
      "script_tags": [
          {
              "created_at": "2015-03-12T15:35:12.242+08:00",
              "event": "onload",
              "id": 2,
              "src": "//dfdfd.com/ddd.js",
              "updated_at": "2015-03-12T15:39:41.693+08:00"
          }
      ]
      }
      
    • 获取大于指定 ID 的 ScriptTag
    • GET /script_tags?since_id=2
    • {
      "script_tags": [
          {
              "created_at": "2015-03-12T16:18:21.602+08:00",
              "event": "onload",
              "id": 3,
              "src": "http://baidu.com/dd.js",
              "updated_at": "2015-03-12T16:18:21.602+08:00"
          }
      ]
      }
      

GET /script_tags/count

获取应用创建 ScriptTag 总数目

    • 获取应用创建 ScriptTag 总数目
    • GET /script_tags/count
    • {
      "count": 3
      }
      

GET /script_tags/#{id}

获取指定 ID 的 ScriptTag

    • 获取ID为2的 ScriptTag
    • GET /script_tags/2
    • {
      "script_tag": {
          "id": 2,
          "event": "onload",
          "src": "//dfdfd.com/ddd.js",
          "created_at": "2015-03-12T15:35:12.242+08:00",
          "updated_at": "2015-03-12T15:39:41.693+08:00"
      }
      }
      

POST /script_tags

创建一个新的 ScriptTag

    • 创建 ScriptTag
    • POST /script_tags
      {
      "script_tag": {       
          "event": "onload",
          "src": "http://static.js.com/asset.js"
      }
      }
      
    • {
      "script_tag": {
          "id": 8,
          "event": "onload",
          "src": "http://static.js.com/asset.js",
          "created_at": "2015-04-02T01:07:06.670+08:00",
          "updated_at": "2015-04-02T01:07:06.670+08:00"
      }
      }
      
    • 缺少src属性,创建 ScriptTag 时会返回错误信息
    • POST /script_tags
      {
      "script_tag": {       
          "event": "onload"
      }
      }
      
    • {
      "code": 422,
      "errors": {
          "src": [
              "不可为空"
          ]
      }
      }
      

PUT /script_tags/#{id}

修改指定 ID 的 ScriptTag

    • 修改 ScriptTag 的src
    • PUT /script_tags/8
      {
      "script_tag": {               
          "src": "http://change.js.com/asset.js"
      }
      }
      
    • {
      "script_tag": {
          "id": 8,
          "event": "onload",
          "src": "http://change.js.com/asset.js",
          "created_at": "2015-04-02T01:07:06.670+08:00",
          "updated_at": "2015-04-02T01:11:17.764+08:00"
      }
      }
      

DELETE /script_tags/#{id}

删除指定 ID 的 ScriptTag

    • 将指定 ID 的 ScriptTag 移除
    • DELETE /script_tags/8
    • {}
      
友好速搭,让商业更简单
0元开始
联系客服
电话咨询
服务热线
0755-83051027
获取报价
QQ咨询
微信咨询
微信二维码
在线咨询

在线获取方案和报价,专人快速响应

所选城市 *

您的称呼 *

联系电话 *

网站类型 *

请选择
展示官网 电商网站 微信商城 小程序 其他类型

您希望我们为您提供哪些服务?(可多选)

B2C商城 跨境解决方案 B2B2C平台电商 网站备案 自营电商培训
获取报价

提交成功

你好, XXX女士/先生 ,你的需求已提交成功,后续会有专门的客户经理与你电话联系。谢谢!