maltertech/mongoify

Mongoify 是一个简单的 PHP 包,旨在无缝集成 Shopify 的 webhook 系统和 MongoDB。

1.0.3 2024-02-04 03:06 UTC

This package is auto-updated.

Last update: 2024-09-04 04:15:59 UTC


README

概述

Mongoify 是一个简单的 PHP 包,旨在无缝集成 Shopify 的 webhook 系统和 MongoDB。它作为一个桥梁,便于 Shopify 事件与 MongoDB 数据库的实时同步。对于希望基于 Shopify 平台构建集成的开发者来说,此包特别有用。

特性

  • Shopify Webhook 验证:验证传入的 Shopify webhook 请求。
  • 数据处理:转换和准备 webhook 数据以进行数据库操作(BSON 日期)。
  • MongoDB 集成:基于 webhook 事件支持创建、更新和删除操作。

要求

为了有效使用 Mongoify,请确保满足以下要求:

  • PHP 版本:PHP 7.0 或更高版本。
  • MongoDB PHP 驱动程序:MongoDB PHP 驱动程序必须安装在你的 PHP 环境中。
  • MongoDB 服务器:访问 MongoDB 服务器,可以是本地或远程托管。
  • Web 服务器:用于部署你的 PHP 应用程序的 Web 服务器。此服务器将作为 Shopify webhook 的端点,允许 Mongoify 接收并处理数据。
  • 具有 Webhooks 的 Shopify 账户:具有配置好的 webhooks 的活动 Shopify 账户。

安装

使用 Composer 安装 Mongoify

composer require maltertech/mongoify

用法

初始化

创建 Mongoify 类的一个实例

require __DIR__ . '/vendor/autoload.php';

use Mongoify\Mongoify;

$mongoify = new Mongoify(
    'your-shopify-client-secret',
    new MongoDB\Client('your-mongodb-connection-string'),
    'your-database-name'
);

方法

Mongoify 提供了几个访问数据的方法

  • getTopic():返回 Shopify 主题头。
  • getCollection():返回集合名称。
  • getAction():返回 Shopify 动作头。
  • getWebhook():返回 webhook 数据。

错误处理

Mongoify 对于任何处理问题都会抛出 ErrorException

支持

有关支持、查询或贡献,请参阅存储库中的问题跟踪器或联系包维护者。