magedin/module-newsletter-api

MagedIn_NewsletterApi模块通过提供一套全面的API来管理新闻订阅,扩展了Magento 2的功能。该模块允许开发者通过强大且安全的API轻松集成和管理新闻订阅功能。

1.0.0 2024-07-11 15:12 UTC

This package is auto-updated.

Last update: 2024-09-11 15:29:09 UTC


README

概述

The MagedIn_NewsletterApi模块通过提供一套全面的API来管理新闻订阅,扩展了Magento 2的功能。该模块允许开发者通过强大且安全的API轻松集成和管理新闻订阅功能。

特性

  • 订阅和取消订阅用户到新闻订阅
  • 检索订阅者信息
  • 管理订阅状态
  • 安全且易于使用的端点

安装

先决条件

  • Magento 2.3.x, 2.4.x
  • Composer

使用新的API端点

使用客户令牌

  • 获取自我订阅状态

    • 端点: GET /V1/newsletter/subscription/mine
  • 自我订阅

    • 端点: POST /V1/newsletter/subscription/mine
  • 自我取消订阅

    • 端点: DELETE /V1/newsletter/subscription/mine

无需令牌

  • 通过电子邮件进行访客订阅

    • 端点: POST /V1/newsletter/guest-subscription
    • 有效载荷:
      {
        "email": "Kenna.McClure85@hotmail.com",
        "store_id": 1
      }
  • 通过电子邮件取消访客订阅

    • 端点: POST /V1/newsletter/guest-subscription/delete
    • 有效载荷:
      {
        "email": "Kenna.McClure85@hotmail.com",
        "store_id": 1
      }

使用管理令牌

  • 获取订阅状态

    • 端点: GET /V1/newsletter/subscription/:customer_id
  • 订阅

    • 端点: POST /V1/newsletter/subscription
    • 有效载荷:
      {
        "customer_id": 1,
        "store_id": 1
      }
  • 取消订阅

    • 端点: POST /V1/newsletter/subscription/delete
    • 有效载荷:
      {
        "customer_id": 1,
        "store_id": 1
      }

支持

对于任何问题或疑问,请联系我们的支持团队

贡献

我们欢迎对改进此模块的贡献。请将您的pull请求提交到develop分支。

致谢

感谢您使用MagedIn Technology的Magento 2新闻订阅API。您的反馈和支持非常宝贵。