jrebs / easyship-laravel

将 easyship-php 集成到 Laravel 应用程序的包

v1.0 2021-04-25 03:22 UTC

This package is auto-updated.

Last update: 2024-09-04 12:07:56 UTC


README

License

这是一个 PHP 补充包,用于 easyship-php 包,它允许用户快速轻松地将 jrebs/easyship-php 库集成到 Laravel 应用程序中。

安装

使用 composer 进行安装。

composer require jrebs/easyship-laravel

配置

此支持包使用默认配置,适用于大多数目的。以下 .env 变量受支持

# Your access token for making calls to the Easyship API
EASYSHIP_API_TOKEN="mytoken"

# The hostname of the Easyship API server (can override for testing)
# Defaults to the official API host https://api.easyship.com
EASYSHIP_API_HOST="http://my-dev-hostname"

# Your secret key for verifying the signature of webhook posts
EASYSHIP_WEBHOOK_SECRET_1="mysecret"

如果您想控制配置的处理方式,只需将此包中的配置文件发布到您的应用程序中,然后您可以随心所欲地处理它,包括设置传递给 GuzzleHttp\Client 实例的默认请求选项。

php artisan vendor:publish --provider=Easyship\\Providers\\EasyshipServiceProvider

发布后,根据口味调整 config/easyship.php 文件。您可能需要这样做的原因之一是支持来自不同 Easyship 账户的传入 webhook。为此,从 v1.0 版本开始,配置进行了修改,支持任意数量的 webhook 秘钥。修改配置文件中的 webhook_secrets 数组以包含您将在 .env 文件中定义的每个密钥。

用法

将包引入应用程序并提供配置密钥后,您应该能够通过使用任何常规方法从 Laravel 服务容器中获取 API 来开始使用 API,或者如果您喜欢,可以使用提供的 Facade 访问器。

// Using the app() helper
// app(\Easyship\EasyshipAPI::class) also works
$api = app('easyship.api');
$categories = $api->categories()->list();

// ...or using the Facade
$categories = Easyship::categories()->list();

同样,webhook 处理程序可以从服务容器中预先配置。不提供此对象的 facade,因为它几乎没有价值。

$handler = app('easyship.handler');
// Can also use app(\Easyship\Webhooks\Handler::class)
$handler->handle($signature, $payload);

支持

如果您发现此集成包存在特定问题,请在此存储库中提出问题。如果您发现底层 easyship-php 包(可能性更大)存在问题,请访问 该项目页面 以获取支持或提交问题报告。

许可证

此软件由我编写,Justin Rebelo,并按照 MIT 许可证 发布。