README

Bol.com 零售商 API PHP

一个用于与 Bol.com 零售商 API v8 交互的 PHP 客户端

关于项目

该项目是用 php v8.1.4 构建的，并且尚未完成。本项目只包含了我项目中需要使用的端点。除非 Bol.com 零售商 API 发布新版本或我需要使用更多端点，否则我这边将不会有未来的发布。

请随意 fork 此项目，并将你的工作贡献给项目以改进它。

支持的端点

• 订单
• 退货
• 订阅
• 处理状态

入门

安装

该项目可以通过 Composer 轻松安装

composer require jeffrey-kroonen/bol-retailer-api-php

使用方法

创建 Client 的新实例

$client = new Client(
    bolClientId: '<client-id>',
    bolClientSecret: '<client-secret>'
);

在 Bol.com 零售商 API 上进行身份验证

$client->authenticate();

在 Bol.com 零售商 API 上完成身份验证后，您可以获取授权数据，例如客户端 ID、客户端密钥和访问令牌。这些数据可用于未来的请求。将访问令牌保存在本地数据库中以供下次重用是一种良好的做法

$client->getAuth();

在实例化 Client 时设置访问令牌

$client = new Client(
    bolClientId: '<client-id>',
    bolClientSecret: '<client-secret>',
    accessToken: '<access-token>'
);

接下来，您可以调用您想要使用的端点

$ordersEndpoint = $client->orders();

然后您可以调用该端点可用的方法

$ordersEndpoint->orders(); // Retrieve a Paginate class instance containing orders
$ordersEndpoint->orderById(id: '<order-id>'); // Retrieve an order by id

要获取当前已认证应用程序的数据，您可以使用 Client 上的访问器

$client->getAuth(); // Returns an instance of Auth

例如，您可以获取认证何时过期的 Unix 时间戳

$client->getAuth()->getExpiresIn(); // 1661613446

当请求不再授权时，您将收到 UnauthorizedException 异常。您可以手动检查认证何时过期

$client->isAuthenticated();

贡献

贡献使开源社区成为一个学习、灵感和创造的地方。您做出的任何贡献都将受到极大的赞赏。

如果您有改进此项目的建议，请 fork 存储库并创建一个 pull request。您也可以简单地通过带有“增强”标签的问题来提出问题。别忘了为项目加星！再次感谢！

1. fork 项目
2. 创建你的功能分支（git checkout -b feature/AmazingFeature）
3. 提交你的更改（git commit -m '添加一些 AmazingFeature'）
4. 推送到分支（git push origin feature/AmazingFeature）
5. 打开 pull request