https://github.com/SnowdogApps/magento2-cms-api

Custom CMS API endpoints which retrieves CMS pages and blocks filtered
https://github.com/SnowdogApps/magento2-cms-api

Last synced: 5 days ago
JSON representation

Custom CMS API endpoints which retrieves CMS pages and blocks filtered

• Host: GitHub
• URL: https://github.com/SnowdogApps/magento2-cms-api
• Owner: SnowdogApps
• License: mit
• Created: 2018-06-25T06:31:52.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-06T09:55:49.000Z (about 1 year ago)
• Last Synced: 2024-05-22T18:31:35.403Z (6 months ago)
• Language: PHP
• Size: 57.6 KB
• Stars: 31
• Watchers: 12
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-vuestorefront - magento2-cms-api - Custom CMS API endpoints which retrieves CMS pages and blocks filtered (Resources for Vue Storefront 1 / Official Resources - v1)

README

        
# Snowdog CMS API

The module provides endpoints to get CMS blocks and pages filtered.

### 1. Installation:

* `composer require snowdog/module-cms-api`

* `bin/magento module:enable Snowdog_CmsApi`

* `bin/magento setup:upgrade`

### 2. Available endpoints: 

* `/rest/V1/snowdog/cmsPage/:pageId`: retrieves page info by its id (integer value)

* `/rest/V1/snowdog/cmsPage/search`: retrieves the list of pages (accepts search criteria filters)

* `/rest/V1/snowdog/cmsPageIdentifier/:identifier/storeId/:storeId`: retrieves page info by its identifier (string value) and store id (integer value)

* `/rest/V1/snowdog/cmsBlock/:blockId`: retrieves block info by its id (integer value)

* `/rest/V1/snowdog/cmsBlockIdentifier/:identifier/storeId/:storeId`: retrieves block info by its identifier (string value) and store id (integer value)

* `/rest/V1/snowdog/cmsBlock/search`: retrieves the list of blocks (accepts search criteria filters)

## License

[MIT](LICENSE.md)