Download the PHP package magedin/module-newsletter-api without Composer
On this page you can find all versions of the php package magedin/module-newsletter-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download magedin/module-newsletter-api
More information about magedin/module-newsletter-api
Files in magedin/module-newsletter-api
Package module-newsletter-api
Short Description The MagedIn_NewsletterApi module extends Magento 2's capabilities by providing a comprehensive API for managing newsletter subscriptions. This module allows developers to easily integrate and manage newsletter functionalities through a robust and secure API.
License OSL-3.0
Informations about the package module-newsletter-api
Newsletter API for Magento 2 by MagedIn Technology
Overview
The MagedIn_NewsletterApi
module extends Magento 2's capabilities by providing a comprehensive API for managing newsletter subscriptions. This module allows developers to easily integrate and manage newsletter functionalities through a robust and secure API.
Features
- Subscribe and unsubscribe users to newsletters
- Retrieve subscriber information
- Manage subscription statuses
- Secure and easy-to-use endpoints
Installation
Prerequisites
- Magento 2.3.x, 2.4.x
- Composer
Usage of New API Endpoints
Using Customer Token
-
Get Self Subscription Status
- Endpoint: GET
/V1/newsletter/subscription/mine
- Endpoint: GET
-
Subscribe Self
- Endpoint: POST
/V1/newsletter/subscription/mine
- Endpoint: POST
- Unsubscribe Self
- Endpoint: DELETE
/V1/newsletter/subscription/mine
- Endpoint: DELETE
No Token Needed
-
Guest-Subscribe by Email
- Endpoint: POST
/V1/newsletter/guest-subscription
- Payload:
- Endpoint: POST
- Guest Unsubscribe by Email
- Endpoint: POST
/V1/newsletter/guest-subscription/delete
- Payload:
- Endpoint: POST
Using Admin Token
-
Get Subscription Status
- Endpoint: GET
/V1/newsletter/subscription/:customer_id
- Endpoint: GET
-
Subscribe
- Endpoint: POST
/V1/newsletter/subscription
- Payload:
- Endpoint: POST
- Unsubscribe
- Endpoint: POST
/V1/newsletter/subscription/delete
- Payload:
- Endpoint: POST
Support
For any issues or questions, please contact our support team:
- Email: [email protected]
Contributing
We welcome contributions to improve this module. Please submit your pull requests to the develop branch.
Acknowledgments
Thank you for using Newsletter API for Magento 2 by MagedIn Technology. Your feedback and support are greatly appreciated.