mvdgeijn/pax8

用于与pax8.com API通信的库

v2.7.1 2024-03-04 11:25 UTC

README

一个用于Pax8集成的Laravel库。使用Pax8 Rest API使您的Laravel应用程序能够直接与您的Pax8账户通信。

安装

使用Composer安装此Pax8 PHP库

composer require 'mvdgeijn/pax8'

别名

在config\app.php文件中,将以下行添加到'aliases'数组中

'Pax8' => Mvdgeijn\Pax8\Facades\Pax8::class,

.env

您可以从Pax8面板获取您的开发者凭据: https://docs.pax8.com/api/v1#section/Create-a-Developer-Application

将凭据添加到您的项目.env文件中。这些凭据用于获取访问令牌。此访问令牌有效期为24小时,因此建议您存储它并在24小时内更新。请参阅下面的“事件”部分。

PAX8_CLIENT_ID="您的客户端ID"

PAX8_CLIENT_SECRET="您的客户端密钥"

请求的访问令牌存储在默认缓存中并从中请求。

用法

$companies = Pax8::companyRequest();

$list = $companies->list();

$company = $companies->get( $list[0]->getId() );

$contacts = Pax8::contactRequest();

$list = $contacts->list( $company->getId() );

$contact = $contacts->get( $company->getId(), $list[0]->getId() );

事件

此包触发一个事件:Mvdgeijn/Pax8/Pax8AccessTokenCreatedEvent。此事件可以用于将新创建的AccessToken存储在某个地方。

namespace App\Listeners;

use Mvdgeijn\Pax8\Events\Pax8AccessTokenCreatedEvent;

class Pax8AccessTokenCreatedListener
{
    public function handle(Pax8AccessTokenCreatedEvent $event)
    {
        //
        // The new accessToken object can be access using $event->accessToken
        //
        // Store $event->accessToken->accessToken and $event->accessToken->expiryTimestamp
        // for later usage
        //
    }
}

需要注意的事项

在开发此包的过程中,我遇到了一些陷阱。以下是一些建议,希望能为您节省一些时间。

  • 在创建订单请求时,您必须为每个要订购的产品向lineItems数组添加一个lineItem。对于每个lineItem,都有一个必需的配置详情数组。每个产品都有自己的配置详情,您可以使用productRequest()->getProvisioningDetails()请求获取。

支持的资源

链接

作者