dropcart/dropcart-api-php

Dropcart API 的 PHP 连接器

0.5.1 2023-12-08 11:07 UTC

This package is auto-updated.

Last update: 2024-09-08 13:12:42 UTC


README

简介

Dropcart 是一个专门用于直邮的电子商务平台。使用此 API 连接器,您可以使用自己的解决方案(如网店或供应链管理系统)与 Dropcart 平台进行交互。

要求

要使用 Dropcart API 连接器,您只需要公共和私有密钥。这些可以在您在 Dropcart 网站上创建的每个供应商或商店的设置中找到。

Dropcart API 连接器至少需要 PHP 7.2。您可能需要安装并启用 JSON 模块。

安装

安装 Dropcart API 连接器最简单的方法是通过 Composer

$ composer require dropcart/dropcart-api-php

入门

初始化 Dropcart API 连接器

$token = (new \Dropcart\Api\Token())->setKeyPairFromEnvironment();
$dropcart = new \Dropcart\Api\Client($token);

第一行从环境中读取公共和私有密钥(即 密钥对),这是推荐的方式。默认情况下,环境变量名为 DROPCART_PUBLIC_KEYDROPCART_PRIVATE_KEY,但您可以使用其他名称。请参阅文档以获取更多详细信息和其他设置密钥对的方法。

示例

检索产品分页列表

$products = $dropcart->supplier()->products()->list(new \Dropcart\Api\Types\Supplier\Product\Listing());

这将返回一个 ProductCollection 实例。您可以通过 getData() 方法获取数据,或者简单地使用 foreach 迭代对象。

// returns array of ProductResource objects
$products->getData();

foreach ($products as $product) {
    // $product is a ProductResource
}

Listing 参数实例包含控制要返回哪些数据的方法。