laraditz/lazada

Laravel 用于与 Lazada API 交互的包。

1.0.1 2023-12-01 09:11 UTC

This package is auto-updated.

Last update: 2024-09-30 01:46:49 UTC


README

Laravel Wallet

Laravel Lazada

Latest Version on Packagist Total Downloads GitHub Actions

Laravel 用于与 Lazada API 交互的包。

要求

  • PHP 8.1 及以上。
  • Laravel 9 及以上。

安装

您可以通过 composer 安装此包

composer require laraditz/lazada

开始前

在您的 .env 中配置变量(推荐),或者您可以将配置文件发布并更改它。

LAZADA_APP_KEY=<your_lazada_app_key>
LAZADA_APP_SECRET=<your_lazada_app_secret>
LAZADA_SELLER_ID=MYXXXXXXXX

(可选)您可以通过以下命令发布配置文件

php artisan vendor:publish --provider="Laraditz\Lazada\LazadaServiceProvider" --tag="config"

运行迁移命令以创建必要的数据库表。

php artisan migrate

在 Lazada 开放平台上,在应用管理部分配置此 应用回调 URL。一旦卖家授权了应用,它将重定向到该 URL。在底层,它将调用 API 生成访问令牌,这样您就不必手动调用它。如果您想使用自己的 应用回调 URL,您可以在 .env 中指定 LAZADA_APP_CALLBACK_URL,但您需要手动调用 accessToken() API 来更新记录中的访问令牌。

// App Callback URL
https://your-app-url.com/lazada/seller/authorized

可用方法

以下是此包下所有可用方法。所有方法调用的参数将严格按照 Lazada 开放平台文档 中的说明。

用法

您可以使用服务容器来发起 API 调用

app('lazada')->auth()->authorizationUrl(); // give URL to seller to authorize app
app('lazada')->order()->get(order_id: '16090'); // get specific order

或者您可以使用外观

use Lazada;
use Laraditz\Lazada\Exceptions\LazadaAPIError;

try {
    // Generate access token. Get the code after seller has authorized the app.
    $accessToken = Lazada::auth()->accessToken(code: '0_123456_XxxXXXXxxXXxxXXXXxxxxxxXXXXxx');   
} catch (LazadaAPIError $e) {
    // Catch API Error
    // $e->getMessage()
    // $e->getMessageCode()
    // $e->getRequestId()
    // $e->getResult() // raw response
    throw $e;
} catch (\Throwable $th) {
    throw $th;
}

// Get order list
Lazada::order()->list(created_after: '2023-11-17T00:00:00+08:00');

事件

此包还提供了一个事件,允许您的应用程序监听 Lazada 网页推送。您可以在以下事件下创建您的监听器并注册它。

有关 Lazada 推送机制(LPM)的更多信息,请参阅 此处

Webhook URL

您可以在 Lazada 开放 API 仪表板的推送机制部分设置以下回调 URL,以便 Lazada 将所有内容更新推送到此 URL 并触发上述 WebPushReceived 事件。

https://your-app-url.com/lazada/webhooks

命令

lazada:flush-expired-token    Flush expired access token.
lazada:refresh-token          Refresh existing access token before it expired.

由于 Lazada 访问令牌有一个过期日期,您可能想在计划程序上设置 lazada:refresh-token 并在它过期之前运行它来刷新访问令牌。否则,您需要卖家重新授权并生成新的访问令牌。

令牌持续时间

生产环境

  • 访问令牌:30天
  • 刷新令牌:180天

测试环境

  • 访问令牌:7天
  • 刷新令牌:30天

测试环境

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

如果您发现任何安全相关的问题,请通过电子邮件 raditzfarhan@gmail.com 而不是使用问题跟踪器。

致谢

许可证

MIT 许可证(MIT)。请参阅 许可证文件 了解更多信息。