Download the PHP package albedo/module-newsletter-api without Composer
On this page you can find all versions of the php package albedo/module-newsletter-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download albedo/module-newsletter-api
More information about albedo/module-newsletter-api
Files in albedo/module-newsletter-api
Package module-newsletter-api
Short Description REST API Layer for Magento Newsletter module.
License OSL-3.0
Informations about the package module-newsletter-api
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.
Read more on: https://karnowka.com/posts/magento2-newsletter-api/
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:
⚠️ 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