README

Analog Bridge 包含一个 JavaScript 客户端和 REST API，允许用户直接将模拟媒体导入到您的应用程序或网站上。

安装

使用 composer 安装

composer require analogbridge/analog-bridge-php

或下载源代码

$ git clone https://github.com/analogbridge/analog-bridge-php.git

配置

一旦您从 Analog Bridge 获得API密钥，您可以使用 secret_key 初始化配置

$bridge = new \AnalogBridge\Customer("Your secret API Key");

使用方法

客户

创建客户

要使用API创建新客户，请使用以下方法

$bridge = new \AnalogBridge\Customer("Your secret API Key");
$customer = $bridge->create([
    "email" => "demo@analogbridge.io",
    "shipping" => [
        "first_name" => "John",
        "last_name" => "Smith",
        "address1" => "3336 Commercial Ave",
        "city" => "Northbrook",
        "state" => "IL",
        "zip" => "60062",
        "phone" => "800-557-3508",
        "email" => "demo@analogbridge.io"
    ],
    "metadata" => [
        "user_id" => 123456
    ]
]);

检索客户信息

我们可以轻松地使用客户的 customer_id 检索客户信息，例如找到具有 id cus_12345678 的客户

$customer = $bridge->get("cus_12345678");

检索所有客户

Analog Bridge 提供了一个接口，可以轻松检索所有客户。要检索所有客户，您可以使用

$customers = $bridge->all(["offset" => 100, "limit" => 100]);

更新客户

通过使用创建客户时使用的 cus_id 来更新现有客户信息。任何未提供的参数对客户对象没有影响。此调用的参数与创建客户调用的参数基本相同。

$bridge->update("cus_12345678", [
            "email" => "new-email@analogbridge.io",
            "shipping" => [
                "address1" => "123 Main St.",
                "city" => "New York",
                "state" => "NY",
                "zip" => "12345"
            ]
        ]);

删除客户

如果我们需要删除客户，例如 id cus_123456789，则可以使用

$bridge->delete("cus_123456789");

订单

列出所有客户订单

Analog Bridge API 允许我们检索特定 customer 的所有订单。例如，如果我们想检索具有 id cus_12345678 的所有 orders，我们可以使用

$bridge = new \AnalogBridge\Order("Your secret API Key");
$order = $bridge->all("cus_3ab7aa6ec5feda6fe8a3");

列出订单详情

如果我们需要检索特定订单的详细信息，则可以使用

$order = $bridge->get("cus_3ab7aa6ec5feda6fe8a3", "ord_fe310b878dc3313c3c2e");

检索准备导入的订单

一旦客户订单经过处理并上传到我们的云，它们就为您的系统准备好了导入。要检索准备导入的订单列表，我们可以使用

$order = $bridge->import_ready();

列出产品

要检索 products，请使用以下接口

$bridge = new \AnalogBridge\Product();
$products = $bridge->all();

贡献

欢迎在 GitHub 上提交错误报告和拉取请求 https://github.com/analogbridge/analog-bridge-php。本项目旨在成为一个安全、欢迎的协作空间，并期望贡献者遵守贡献者公约行为准则。

许可

此软件包可在 MIT 许可证的条款下作为开源软件使用 https://open-source.org.cn/licenses/MIT。

analogbridge / analog-bridge-php

维护者

详细信息