adamkarnowka / magento2-newsletter-api
adamkarnowka/magento2-newsletter-api
REST API Layer for Magento Newsletter module.
Magento2 API Endpoint for Newsletter module
albedo/module-newsletter-api
Description
REST API Layer for Magento Newsletter module adds additional 4 methods which allow to list and manage Magento subscribers.
Somehow, Magento Newsletter doesn't provide these methods out of the box, while they might be useful for 3rd party integrations with ESPs or other marketing software.
Features:
- Possibility to get list using
searchCriteria - Possiblity to subscribe/confiirm/unsubscribe using REST
- Separate ACL rules for read/write permissions
When e-mail is subscribed, it will trigger/dispatch all observers and send e-mail to customer. It is equivalent to subscribe with normal form (same Magento methods used).
📖 API Reference (Postman): https://documenter.getpostman.com/view/4376907/TVsxCSUj
You can run tests by executing:
php ../../../vendor/bin/phpunit ../../../app/code/Albedo/NewsletterApi/Test/* -c ../api-functional/phpunit_rest.xml
⚠️ Make sure to have api-functional/phpunit_rest.xml properly configured!
Roadmap:
- possibility to send multiple contacts in one requests
- deleting subscribers
Installation
Install the module composer by running
composer require albedo/module-newsletter-api
Enable the module by running
php bin/magento module:enable Albedo_NewsletterApi
Apply database updates by running
php bin/magento setup:upgrade
Flush the cache by running
php bin/magento cache:flush
No changelog yet
The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.
No dependencies declared
This package's composer.json doesn't declare any required, suggested, replaced, or conflicting packages.
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.
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. Cell → details modal.
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 |
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.
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.