snowdog / module-cms-api
snowdog/module-cms-api
Custom CMS API endpoints which retrieves CMS pages and blocks filtered
Snowdog CMS API
The module provides endpoints to get CMS blocks and pages filtered.
1. Installation:
composer require snowdog/module-cms-apibin/magento module:enable Snowdog_CmsApibin/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
Changelog
All notable changes to this project will be documented in this file.
[Unreleased]
[1.11.0] 2023-11-06
- Enabled PHP
8.1and8.2support incomposer.json
[1.10.0] 2020-09-24
- Enabled PHP
7.4support incomposer.json
[1.9.0] 2020-09-07
- Enabled Magento
2.4support incomposer.json
[1.8.0] 2020-08-28
- Added license file.
[1.7.0] 2020-05-11
- Fixed: blocking store emulation if no
store_idparameter is passed through search criteria filters.
[1.6.0] 2019-10-25
- Added compatibility with PHP 7.3.x in composer file (thanks to @WJdeBaas)
[1.5.0] 2019-01-21
- Added compatibility with PHP 7.2.x in composer file
[1.4.0] 2018-12-31
- Added compatibility with Magento 2.3.0 in composer file
[1.3.1] 2018-11-20
- Fixed missing page and block id in search endpoint responses
[1.3.0] 2018-10-15
- If searchCriteria contains only one store_id as filter, the content for blocks/pages will be loaded for the given store id.
[1.2.0] 2018-10-03
- Widgets and content variables are parsed correctly
- CMS Block/Pages List with store_id provided
[1.1.0] 2018-07-23
- Added new API endpoints to get pages/blocks by their identifier
[1.0.0] 2018-06-25
- Init files
| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 1.11.0 | stable | Fail | Partially compatible Details | 2023-11-06 09:55:34 |
| 1.10.0 | stable | Not tested | Not yet tested Details | 2020-09-24 08:02:57 |
| 1.9.0 | stable | Not tested | Not yet tested Details | 2020-09-07 08:31:51 |
| 1.8.0 | stable | Not tested | Not yet tested Details | 2020-08-28 13:39:09 |
| 1.7.0 | stable | Not tested | Not yet tested Details | 2020-05-11 05:41:55 |
| 1.6.0 | stable | Not tested | Not yet tested Details | 2019-10-25 12:49:51 |
| 1.5.0 | stable | Not tested | Not yet tested Details | 2019-01-21 12:24:14 |
| 1.4.0 | stable | Not tested | Not yet tested Details | 2018-12-31 14:03:06 |
| 1.3.1 | stable | Not tested | Not yet tested Details | 2018-11-20 20:51:57 |
| 1.3.0 | stable | Not tested | Not yet tested Details | 2018-10-15 12:07:05 |
| 1.2.0 | stable | Not tested | Not yet tested Details | 2018-10-03 07:33:50 |
| 1.1.0 | stable | Not tested | Not yet tested Details | 2018-07-23 07:08:40 |
| 1.0.0 | stable | Not tested | Not yet tested Details | 2018-06-25 06:40:14 |
Requires 3
| Package | Constraint |
|---|---|
| magento/framework | 101.0.*|102.0.*|103.0.* |
| magento/module-cms | 102.0.*|103.0.*|104.0.* |
| php | 7.0.2|7.0.4|~7.0.6|~7.1.0|~7.2.0|~7.3.0|~7.4.0|~8.1.0|~8.2.0 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | not tested | ||
| 2.4.8 | not tested | not tested | ||
| 2.4.9 | not tested | not tested |
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. A phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from snowdog
View vendorProvides powerful menu editor to replace category based menus in Magento 2
Hyva Checkout compatybility module for PayPo
Hyva Checkout compatybility module for Santander eRaty
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.