开放 API
使用说明
获取授权
全部 API
- Shop
- Metafields
- Customer
- CustomerAddress
- Account
- Product
- ProductVariant
- ProductImage
- Theme
- Asset
- Country
- Province
- City
- District
- ScriptTag
- Order
- Shipment
- ShipmentSupplier
- Payment
- PaymentMethod
- Redirect
- Page
- Webhook
- Blog
- BlogAuthor
- CustomerLevel
- StoreFile
- Promotion
- Coupon
- Post
- AfterSale
ScriptTag
ScriptTag
ScriptTag 可用于在店面主题中,加载指定的javascript
资源,从而实现动态控制店铺页面,而无需修改主题。
ScriptTag 有两个主要属性:
src
:脚本的URLevent
:触发DOM下载脚本的事件,当前只支持onload
应用只能操作自己创建的 ScriptTag,当应用被从店铺移除时,其创建的所有ScriptTag会被同步移除。
ScriptTag 相关API
ScriptTag 属性
- id
Number 类型,ScriptTag 唯一整型标识。{ "id" : 2 }
- event
String 类型,DOM 中触发加载脚本的事件,仅支持{ "event" : "onload" }
onload
。
- src
String 类型,脚本加载网址。{ "src" : "//dfdfd.com/ddd.js" }
- created_at
Datetime 类型,ScriptTag 的创建时间。{ "created_at" : "2015-03-12T15:35:12.242+08:00" }
- updated_at
Datetime 类型,上次更新 ScriptTag 的时间。{ "updated_at" : "2015-03-12T16:18:21.602+08:00" }
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" } }
- 修改 ScriptTag 的
DELETE /script_tags/#{id}
删除指定 ID 的 ScriptTag
- 将指定 ID 的 ScriptTag 移除
- DELETE /script_tags/8
{}