Magento 2 Blog REST API & Examples

Blog REST API for Magento 2

GETGet All Posts

{{magento_base_url}}/rest/V1/mpblog/post?page=1&limit=10

HEADERS

Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS

page

limit

Example Request

curl

curl --location -g '{{magento_base_url}}/rest/V1/mpblog/post?page=1&limit=10' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'

200 OK

Example Response

json

[
  {
    "id": 1,
    "name": "Post 1 ",
    "short_description": "a",
    "post_content": "<p>a</p>",
    "store_ids": 0,
    "image": null,
    "enabled": 1,
    "url_key": "post-1",
    "in_rss": 1,
    "allow_comment": 1,
    "meta_title": "a",
    "meta_description": "a",
    "meta_keywords": "a",
    "meta_robots": "INDEX,FOLLOW",
    "created_at": "2020-10-26 09:30:47",
    "updated_at": "2020-10-26 09:31:30",
    "author_id": 1,
    "modifier_id": 1,
    "publish_date": "2020-10-24 21:30:08",
    "layout": "empty",
    "category_ids": [
      2,
      4
    ],
    "tag_ids": [
      1
    ],
    "topic_ids": [
      1
    ],
    "author_name": "Admin",
    "author_url": "http://192.168.1.200/thu/ce235b/blog/author/admin.html",
    "view_traffic": 15
  },
  {
    "id": 2,
    "name": "update_ example",
    "short_description": "a",
    "post_content": "<p>q</p>",
    "store_ids": 0,
    "image": "i/m/img_1394.jpg",
    "enabled": 1,
    "url_key": "q",
    "in_rss": 1,
    "allow_comment": 1,
    "meta_title": "api",
    "meta_description": null,
    "meta_keywords": null,
    "meta_robots": "INDEX,FOLLOW",
    "created_at": "2020-10-26 09:33:51",
    "updated_at": "2020-11-04 03:02:24",
    "author_id": 1,
    "modifier_id": 1,
    "publish_date": "2020-10-26 21:33:05",
    "layout": "empty",
    "category_ids": [
      2,
      3,
      4
    ],
    "tag_ids": [
      1,
      2
    ],
    "topic_ids": [
      1,
      2
    ],
    "author_name": "Admin",
    "author_url": "http://192.168.1.200/thu/ce235b/blog/author/admin.html",
    "view_traffic": 1
  },
  {
    "id": 3,
    "name": "example1",
    "short_description": "Example",
    "post_content": "<p>mageplaza</p>",
    "store_ids": 0,
    "image": null,
    "enabled": 0,
    "url_key": "example1",
    "in_rss": 0,
    "allow_comment": 0,
    "meta_title": null,
    "meta_description": null,
    "meta_keywords": null,
    "meta_robots": "INDEX,FOLLOW",
    "created_at": "2020-11-04 03:00:33",
    "updated_at": "2020-11-04 03:00:33",
    "author_id": 1,
    "modifier_id": null,
    "publish_date": "2020-11-04 03:00:33",
    "layout": "empty",
    "category_ids": [],
    "tag_ids": [],
    "topic_ids": [],
    "author_name": "Admin",
    "author_url": "http://192.168.1.200/thu/ce235b/blog/author/admin.html",
    "view_traffic": 0
  }
]

Date

Wed, 04 Nov 2020 03:04:18 GMT

Set-Cookie

PHPSESSID=huodniup4ipqbu437vu3cga6of; expires=Wed, 04-Nov-2020 04:04:18 GMT; Max-Age=3600; path=/thu/ce235b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

1771

Content-Type

application/json; charset=utf-8

X-Varnish

463729

Via

1.1 varnish (Varnish/6.1)

Pragma

no-cache

Expires

-1

Cache-Control

no-store, no-cache, must-revalidate, max-age=0

Accept-Ranges

bytes

Connection

keep-alive

GETGet Post With Conditions

{{magento_base_url}}/rest/V1/mpblog/post/list?searchCriteria[filter_groups][0][filters][0][field]=name&searchCriteria[filter_groups][0][filters][0][value]=Post 1&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

HEADERS

Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS

searchCriteria[filter_groups][0][filters][0][field]

name

searchCriteria[filter_groups][0][filters][0][value]

Post 1

searchCriteria[filter_groups][0][filters][0][condition_type]

Example Request

curl

curl --location -g '{{magento_base_url}}/rest/V1/mpblog/post/list?searchCriteria[filter_groups][0][filters][0][field]=name&searchCriteria[filter_groups][0][filters][0][value]=Post%201&searchCriteria[filter_groups][0][filters][0][condition_type]=eq' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'

200 OK

Example Response

json

{
  "items": [
    {
      "id": 1,
      "name": "Post 1 ",
      "short_description": "a",
      "post_content": "<p>a</p>",
      "store_ids": 0,
      "image": null,
      "enabled": 1,
      "url_key": "post-1",
      "in_rss": 1,
      "allow_comment": 1,
      "meta_title": "a",
      "meta_description": "a",
      "meta_keywords": "a",
      "meta_robots": "INDEX,FOLLOW",
      "created_at": "2020-10-26 09:30:47",
      "updated_at": "2020-10-26 09:31:30",
      "author_id": 1,
      "modifier_id": 1,
      "publish_date": "2020-10-24 21:30:08",
      "layout": "empty",
      "category_ids": [
        2,
        4
      ],
      "tag_ids": [
        1
      ],
      "topic_ids": [
        1
      ],
      "author_name": "Admin",
      "author_url": "http://192.168.1.200/thu/ce235b/blog/author/admin.html",
      "view_traffic": 15
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "name",
            "value": "Post 1",
            "condition_type": "eq"
          }
        ]
      }
    ]
  },
  "total_count": 1
}

Date

Wed, 04 Nov 2020 03:03:54 GMT

Set-Cookie

PHPSESSID=huodniup4ipqbu437vu3cga6of; expires=Wed, 04-Nov-2020 04:03:54 GMT; Max-Age=3600; path=/thu/ce235b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

710

Content-Type

application/json; charset=utf-8

X-Varnish

6499

Via

1.1 varnish (Varnish/6.1)

Pragma

no-cache

Expires

-1

Cache-Control

no-store, no-cache, must-revalidate, max-age=0

Accept-Ranges

bytes

Connection

keep-alive

GETView Post

{{magento_base_url}}/rest/V1/mpblog/post/view/:post_id

HEADERS

Content-Type

application/json

Authorization

Bearer {{admin_token}}

PATH VARIABLES

post_id

Example Request

curl

curl --location -g '{{magento_base_url}}/rest/V1/mpblog/post/view/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'

200 OK

Example Response

json

{
  "id": 1,
  "name": "Post 1 ",
  "short_description": "a",
  "post_content": "<p>a</p>",
  "store_ids": 0,
  "image": null,
  "enabled": 1,
  "url_key": "post-1",
  "in_rss": 1,
  "allow_comment": 1,
  "meta_title": "a",
  "meta_description": "a",
  "meta_keywords": "a",
  "meta_robots": "INDEX,FOLLOW",
  "created_at": "2020-10-26 09:30:47",
  "updated_at": "2020-10-26 09:31:30",
  "author_id": 1,
  "modifier_id": 1,
  "publish_date": "2020-10-24 21:30:08",
  "layout": "empty",
  "category_ids": [
    2,
    4
  ],
  "tag_ids": [
    1
  ],
  "topic_ids": [
    1
  ],
  "author_name": "Admin",
  "author_url": "http://192.168.1.200/thu/ce235b/blog/author/admin.html",
  "view_traffic": 15
}

Date

Wed, 04 Nov 2020 03:03:00 GMT

Set-Cookie

PHPSESSID=huodniup4ipqbu437vu3cga6of; expires=Wed, 04-Nov-2020 04:03:00 GMT; Max-Age=3600; path=/thu/ce235b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

574

Content-Type

application/json; charset=utf-8

X-Varnish

6496

Via

1.1 varnish (Varnish/6.1)

Pragma

no-cache

Expires

-1

Cache-Control

no-store, no-cache, must-revalidate, max-age=0

Accept-Ranges

bytes

Connection

keep-alive

DELETEDelete Post

{{magento_base_url}}/rest/V1/mpblog/post/delete/:post_id

HEADERS

Authorization

Bearer {{admin_token}}

PATH VARIABLES

post_id

Example Request

curl

curl --location -g --request DELETE '{{magento_base_url}}rest/V1/mpblog/post/delete/2' \
--header 'Authorization: Bearer {{admin_token}}'

200 OK

Example Response

json

true

Date

Mon, 25 Nov 2019 02:41:37 GMT

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=jn6df8evmhughrfur31uqokbhh; expires=Mon, 25-Nov-2019 03:41:37 GMT; Max-Age=3600; path=/api/api; domain=develop.mageplaza.com; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

Content-Type

application/json; charset=utf-8

Age

X-Cache

MISS

X-Cache-Hits

Accept-Ranges

bytes

Connection

keep-alive