https://github.com/adamkarnowka/magento2-newsletter-api

REST API Layer for Magento Newsletter module adds additional 4 methods which allow to list and manage Magento subscribers.
https://github.com/adamkarnowka/magento2-newsletter-api

api magento2 magento2-free-extension magento2-module newsletter

Last synced: 3 months ago
JSON representation

REST API Layer for Magento Newsletter module adds additional 4 methods which allow to list and manage Magento subscribers.

• Host: GitHub
• URL: https://github.com/adamkarnowka/magento2-newsletter-api
• Owner: adamkarnowka
• License: osl-3.0
• Created: 2020-12-28T12:01:19.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-02T19:51:03.000Z (about 4 years ago)
• Last Synced: 2024-04-25T08:02:26.204Z (9 months ago)
• Topics: api, magento2, magento2-free-extension, magento2-module, newsletter
• Language: PHP
• Homepage:
• Size: 19.5 KB
• Stars: 5
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING.txt

Awesome Lists containing this project

README

        
# 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:

```$xslt 

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`