willemo/laravel-twinfield

Laravel 的 Twinfield 服务提供者

v2.1.0 2022-12-08 09:06 UTC

This package is auto-updated.

Last update: 2024-09-20 10:33:54 UTC


README

Laravel 8 的 Twinfield 服务提供者,增加了 php-twinfield/twinfield API 客户端的功能。

要求

此服务提供者为 Laravel 8 及以上版本编写,运行需要 PHP 8.1。

安装

您可以使用 composer 安装此包

composer require "willemo/laravel-twinfield:^2.0"

该包将被您的 Laravel 安装自动发现,因此您不需要将服务提供者和外观添加到您的应用配置文件中。

需要支持更低版本的 PHP 或 Laravel 吗?

在这种情况下,您可以安装此包的 ^1.0 版本,该版本与 Laravel 5.5+ 和 PHP 7.2+ 兼容。

从版本 0 升级到版本 1

在版本 0.X.X 和 1.X.X 之间,文件结构已修改。升级后请确保所有类引用都正确。

配置

首先您需要发布配置文件

php artisan vendor:publish --provider="Willemo\LaravelTwinfield\TwinfieldServiceProvider"

然后您可以在 config/twinfield.php 中配置 Twinfield API 客户端。配置 Twinfield API 的最佳方式是通过使用环境变量。

使用凭证连接到 API

您可以选择使用您的凭证连接到 Twinfield API

TWINFIELD_AUTH_TYPE=credentials
TWINFIELD_USERNAME=your_username
TWINFIELD_PASSWORD=your_password
TWINFIELD_ORGANISATION=your_organisation
TWINFIELD_OFFICE=your_office

使用 OAuth 连接到 API

或者您可以使用 OAuth 连接到 Twinfield API

TWINFIELD_CLIENT_ID=your_client_id
TWINFIELD_CLIENT_SECRET=your_client_secret
TWINFIELD_RETURN_URL=https://example.org/oauth/return/url
TWINFIELD_ORGANISATION=your_organisation
TWINFIELD_OFFICE=your_office

如果您希望使用 PhpTwinfield API 客户端的 autoRedirect 选项,您可以在 config/twinfield.php 文件中将它启用,设置 'autoRedirect' => true,

用法

您可以使用 Twinfield 外观来获取 API 连接器

$customerApiConnector = \Twinfield::get('Customer');

有关 API 连接器和可用连接器的使用方法,请 查看 PhpTwinfield 文档