Support Sapo

Tổng đài hỗ trợ - 
1900 6750
( 7:00 - 22:00 )

api-reference
tai-lieu-api
tai-lieu-nha-phat-trien

Page

Ngoài website trực tuyến, Sapo Web còn có công cụ tạo trang web, cho phép website có một hoặc nhiều trang. Chủ cửa hàng được khuyến khích sử dụng các trang để biết thông tin mà khách hàng sẽ sử dụng thường xuyên, chẳng hạn như trang 'Giới thiệu', trang 'Liên hệ với chúng tôi', trang có lời chứng thực của khách hàng, v.v.

Chú ý

Page được sử dụng để lưu trữ nội dung tĩnh. Nếu Shop cần một trang nội dung được tạo ra thường xuyên, chúng tôi khuyến nghị bạn nên sử dụng blog.

Bạn có thể làm gì với Page?

Sapo API cho phép bạn thực hiện các thao tác sau với tài nguyên Page. Các phiên bản chi tiết hơn của những thao tác này có thể có:

Các thuộc tính của Page

author
 
{ "author" : "Lydia" }

Tên người tạo Page.

 
content
 
{ "content" : "We don't need a warranty" }

Nội dung HTML của Page

 
created_on
 
{ "created_on" : "2008-07-15T20:00:00Z" }

Thời gian Page được tạo. API trả về kết quả theo định dạng chuẩn ISO 8601.

 
alias
 
{ "alias" : "tos" }

Một xâu ký tự duy nhất, thân thiện với người dùng đại diện cho Page được nhập bằng tay hoặc tự tạo từ tiêu đề của Page.

 
id
 
{ "id" : 131092082 }

Số duy nhất định danh Page.

 
metafield
 
{ "key" : "new" }
{ "value" : "newvalue" }
{ "value_type" : "string" }
{ "namespace" : "global" }

Gắn kèm các thông tin thêm vào tài nguyên của Shop:

  • key (bắt buộc): Định danh cho metafield (tối đa 30 ký tự).
  • namespace (bắt buộc): Nơi chứa tập hợp các metadata. Namespace giúp phân biệt các metadata được thêm vào từ các nguồn khác nhau (tối đa 20 ký tự).
  • value (bắt buộc): Thông tin được lưu trữ dưới dạng metadata.
  • value_type (bắt buộc): Xác định thông tin được lưu trữ dưới định dạng 'string' hay 'integer'.
  • description (tùy chọn): Thông tin thêm về metafield.
 
published_on
 
{ "published_on" : "2014-07-16T20:00:00Z" }

Thuộc tính này có thể có 2 loại giá trị, phụ thuộc vào việc Page có được xuất bản hay không.

  • Nếu Page được xuất bản, thuộc tính này sẽ có giá trị là thời gian Page được xuất bản. API trả về kết quả theo định dạng chuẩn ISO 8601.
  • Nếu Page đang ở trạng thái ẩn, thuộc tính này sẽ có giá trị null.
 
template_layout
 
{ "template_layout" : "null" }

Tên khung giao diện liquid được sử dụng.

 
title
 
{ "title" : "Terms of Services" }

Tiêu đề của Page.

 
modified_on
 
{ "modified_on" : "2008-07-16T20:00:00Z" }

Thời gian Page được cập nhật lần cuối. API trả về kết quả theo định dạng chuẩn ISO 8601.

Endpoints

GET/admin/pages.json

Lấy danh sách các Page 

limit

Số lượng kết quả

(mặc định: 50) (tối đa: 250)		 
page

Số trang

(mặc định: 1)		 
since_id

Giới hạn kết quả có ID sau một ID xác định

 
title

Lấy danh sách Page theo tiêu đề

 
alias

Lấy danh sách Page theo alias

 
created_on_min

Lấy các trang được tạo sau ngày này (định dạng: 2008-12-31)

 
created_on_max

Lấy các trang được tạo trước ngày này (định dạng: 2008-12-31)

 
modified_on_min

Lấy các trang được cập nhật sau ngày này (định dạng: 2008-12-31)

 
modified_on_max

Lấy các trang được cập nhật trước ngày này (định dạng: 2008-12-31)

 
published_on_min

Lấy các trang được xuất bản sau ngày này (định dạng: 2008-12-31 03:00)

 
published_on_max

Lấy các trang được xuất bản trước ngày này (định dạng: 2008-12-31 03:00)

 
fields

danh sách các trường trong kết quả trả về, cách nhau bởi dấu phẩy

 
published
  • true - Lấy ra các Page được xuất bản
  • false - Lấy ra các Page chưa được xuất bản

Lấy các Page của Shop

GET /admin/pages.json
Xem kết quả
HTTP/1.1 200 OK
{
  "pages": [
    {
      "id": 322471,
      "title": "Support",
      
      "alias": "support",
      "content": "<p>Come instore for support.<\/p>",
      "author": "Dennis",
      "created_on": "2009-07-15T20:00:00Z",
      "modified_on": "2009-07-16T20:00:00Z",
      "published_on": null,
      "template_layout": null
    },
    {
      "id": 108828309,
      "title": "Sample Page",
      
      "alias": "sample",
      "content": "<p>this is a <strong>sample<\/strong> page.<\/p>",
      "author": "Dennis",
      "created_on": "2008-07-15T20:00:00Z",
      "modified_on": "2008-07-16T20:00:00Z",
      "published_on": null,
      "template_layout": null
    },
    {
      "id": 131092082,
      "title": "Terms of Services",
      
      "alias": "tos",
      "content": "<p>We make <strong>perfect<\/strong> stuff, we don't need a warranty.<\/p>",
      "author": "Dennis",
      "created_on": "2008-07-15T20:00:00Z",
      "modified_on": "2008-07-16T20:00:00Z",
      "published_on": "2008-07-15T20:00:00Z",
      "template_layout": null
    },
    {
      "id": 169524623,
      "title": "Store hours",
      
      "alias": "store-hours",
      "content": "<p>We never close.<\/p>",
      "author": "Jobs",
      "created_on": "2013-12-31T19:00:00Z",
      "modified_on": "2013-12-31T19:00:00Z",
      "published_on": "2014-02-01T19:00:00Z",
      "template_layout": null
    }
  ]
}

Lấy danh sách các Page có ID sau ID xác định

GET /admin/pages.json?since_id=108828309
Xem kết quả
HTTP/1.1 200 OK
{
  "pages": [
    {
      "id": 131092082,
      "title": "Terms of Services",
      
      "alias": "tos",
      "content": "<p>We make <strong>perfect<\/strong> stuff, we don't need a warranty.<\/p>",
      "author": "Dennis",
      "created_on": "2008-07-15T20:00:00Z",
      "modified_on": "2008-07-16T20:00:00Z",
      "published_on": "2008-07-15T20:00:00Z",
      "template_layout": null
    },
    {
      "id": 169524623,
      "title": "Store hours",
      
      "alias": "store-hours",
      "content": "<p>We never close.<\/p>",
      "author": "Jobs",
      "created_on": "2013-12-31T19:00:00Z",
      "modified_on": "2013-12-31T19:00:00Z",
      "published_on": "2014-02-01T19:00:00Z",
      "template_layout": null
    }
  ]
}
GET/admin/pages/count.json

Lấy tổng số tất cả các Page 

title

Các Page với title xác định

 
created_on_min

Các Page được tạo sau ngày này (định dạng: 2008-12-31)

 
created_on_max

Các Page được tạo trước ngày này (định dạng: 2008-12-31)

 
modified_on_min

Các Page được cập nhật sau ngày này (định dạng: 2008-12-31)

 
modified_on_max

Các Page được cập nhật trước ngày này (định dạng: 2008-12-31)

 
published_on_min

Các Page được xuất bản sau ngày này (định dạng: 2008-12-31 03:00)

 
published_on_max

Các Page được xuất bản trước ngày này (định dạng: 2008-12-31 03:00)

 
published
  • true - Các Page đã được xuất bản
  • false - Các Page chưa xuất bản

Tổng số tất cả các Page của Shop

GET /admin/pages/count.json
Xem kết quả
HTTP/1.1 200 OK
{
  "count": 4
}
GET/admin/pages/131092082.json

Lấy một Page bằng ID 

fields

danh sách các trường trong kết quả trả về, cách nhau bởi dấu phẩy

Lấy một Page

GET /admin/pages/#{id}.json
Xem kết quả
HTTP/1.1 200 OK
{
  "page": {
    "id": 131092082,
    "title": "Terms of Services",
    
    "alias": "tos",
    "content": "<p>We make <strong>perfect<\/strong> stuff, we don't need a warranty.<\/p>",
    "author": "Dennis",
    "created_on": "2008-07-15T20:00:00Z",
    "modified_on": "2008-07-16T20:00:00Z",
    "published_on": "2008-07-15T20:00:00Z",
    "template_layout": null
  }
}
POST/admin/pages.json

Tạo mới một Page

Tạo mới một Page với nội dung Html

POST /admin/pages.json
{
  "page": {
    "title": "Warranty information",
    "content": "<h1>Warranty<\/h1>\n<p><strong>Forget it<\/strong>, we aint giving you nothing<\/p>"
  }
}
Xem kết quả
HTTP/1.1 201 Created
{
  "page": {
    "id": 905192166,
    "title": "Warranty information",
    
    "alias": "warranty-information",
    "content": "<h1>Warranty<\/h1>\n<p><strong>Forget it<\/strong>, we aint giving you nothing<\/p>",
    "author": "Shopify API",
    "created_on": "2015-12-08T11:37:23Z",
    "modified_on": "2015-12-08T11:37:23Z",
    "published_on": "2015-12-08T11:37:23Z",
    "template_layout": null
  }
}

Tạo mới một Page nhưng chưa xuất bản

POST /admin/pages.json
{
  "page": {
    "title": "Warranty information",
    "content": "<h1>Warranty<\/h1>\n<p><strong>Forget it<\/strong>, we aint giving you nothing<\/p>",
    "published": false
  }
}
Xem kết quả
HTTP/1.1 201 Created
{
  "page": {
    "id": 905192167,
    "title": "Warranty information",
    
    "alias": "warranty-information",
    "content": "<h1>Warranty<\/h1>\n<p><strong>Forget it<\/strong>, we aint giving you nothing<\/p>",
    "author": "Shopify API",
    "created_on": "2015-12-08T11:37:24Z",
    "modified_on": "2015-12-08T11:37:24Z",
    "published_on": null,
    "template_layout": null
  }
}

Cố gắng tạo một Page không có tiêu đề sẽ trả về lỗi

POST /admin/pages.json
{
  "page": {
    "body": "foobar"
  }
}
Xem kết quả
HTTP/1.1 422 Unprocessable Entity
{
  "errors": {
    "title": [
      "can't be blank"
    ]
  }
}

Tạo một Page với Metafield

POST /admin/pages.json
{
  "page": {
    "title": "Warranty information",
    "content": "<h1>Warranty<\/h1>\n<p><strong>Forget it<\/strong>, we aint giving you nothing<\/p>",
    "metafields": [
      {
        "key": "new",
        "value": "newvalue",
        "value_type": "string",
        "namespace": "global"
      }
    ]
  }
}
Xem kết quả
HTTP/1.1 201 Created
{
  "page": {
    "id": 905192168,
    "title": "Warranty information",
    
    "alias": "warranty-information",
    "content": "<h1>Warranty<\/h1>\n<p><strong>Forget it<\/strong>, we aint giving you nothing<\/p>",
    "author": "Shopify API",
    "created_on": "2015-12-08T11:37:28Z",
    "modified_on": "2015-12-08T11:37:28Z",
    "published_on": "2015-12-08T11:37:28Z",
    "template_layout": null
  }
}
PUT/admin/pages/131092082.json

Cập nhật một Page

Cập nhật một Page

PUT /admin/pages/#{id}.json
{
  "page": {
    "id": 131092082,
    "content": "<p>Okay, maybe we will give you a warranty.<\/p>",
    "author": "Your name",
    "title": "My new Title",
    "alias": "new-title"
  }
}
Xem kết quả
HTTP/1.1 200 OK
{
  "page": {
    "id": 131092082,
    "title": "My new Title",
    "shop_id": 690933842,
    "alias": "new-title",
    "content": "<p>Okay, maybe we will give you a warranty.<\/p>",
    "author": "Your name",
    "created_on": "2008-07-15T20:00:00Z",
    "modified_on": "2015-12-08T11:37:25Z",
    "published_on": "2008-07-15T20:00:00Z",
    "template_layout": null
  }
}

Hiển thị một Page ẩn bằng cách đổi giá trị thuộc tính published thành ngày trong quá khứ

PUT /admin/pages/#{id}.json
{
  "page": {
    "id": 131092082,
    "published": "2008-07-15T20:00:00Z"
  }
}
Xem kết quả
HTTP/1.1 200 OK
{
  "page": {
    "id": 131092082,
    "title": "Terms of Services",
    
    "alias": "tos",
    "content": "<p>We make <strong>perfect<\/strong> stuff, we don't need a warranty.<\/p>",
    "author": "Dennis",
    "created_on": "2008-07-15T20:00:00Z",
    "modified_on": "2015-12-08T11:37:26Z",
    "published_on": "2015-12-08T11:37:26Z",
    "template_layout": null
  }
}

Cập nhật thuộc tính content của Page

PUT /admin/pages/#{id}.json
{
  "page": {
    "id": 131092082,
    "content": "<p>Okay, maybe we will give you a warranty.<\/p>"
  }
}
Xem kết quả
HTTP/1.1 200 OK
{
  "page": {
    "id": 131092082,
    "title": "Terms of Services",
    
    "alias": "tos",
    "content": "<p>Okay, maybe we will give you a warranty.<\/p>",
    "author": "Dennis",
    "created_on": "2008-07-15T20:00:00Z",
    "modified_on": "2015-12-08T11:37:27Z",
    "published_on": "2008-07-15T20:00:00Z",
    "template_layout": null
  }
}

Ẩn một Page đã xuất bản bằng cách đổi giá trị thuộc tính published thành null

PUT /admin/pages/#{id}.json
{
  "page": {
    "id": 131092082,
    "published": null
  }
}
Xem kết quả
HTTP/1.1 200 OK
{
  "page": {
    "id": 131092082,
    "title": "Terms of Services",
    
    "alias": "tos",
    "content": "<p>We make <strong>perfect<\/strong> stuff, we don't need a warranty.<\/p>",
    "author": "Dennis",
    "created_on": "2008-07-15T20:00:00Z",
    "modified_on": "2015-12-08T11:37:27Z",
    "published_on": null,
    "template_layout": null
  }
}

Thêm metafield vào một Page

PUT /admin/pages/#{id}.json
{
  "page": {
    "id": 131092082,
    "metafields": [
      {
        "key": "new",
        "value": "newvalue",
        "value_type": "string",
        "namespace": "global"
      }
    ]
  }
}
Xem kết quả
HTTP/1.1 200 OK
{
  "page": {
    "id": 131092082,
    "title": "Terms of Services",
    
    "alias": "tos",
    "content": "<p>We make <strong>perfect<\/strong> stuff, we don't need a warranty.<\/p>",
    "author": "Dennis",
    "created_on": "2008-07-15T20:00:00Z",
    "modified_on": "2015-12-08T11:37:28Z",
    "published_on": "2008-07-15T20:00:00Z",
    "template_layout": null
  }
}
DELETE/admin/pages/131092082.json

Xóa một Page

Xóa một Page khỏi Shop

DELETE /admin/pages/#{id}.json
Xem kết quả
HTTP/1.1 200 OK
{}

Bài viết trên có hữu ích cho bạn không?

Hữu ích Không hữu ích
Số lượt đánh giá hữu ích: