acadea/connectwise-php

PHP/Laravel 的可扩展 Connectwise API 客户端。

dev-master 2019-10-08 07:05 UTC

This package is auto-updated.

Last update: 2024-09-08 18:16:02 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

轻量级且可扩展的 Laravel 6 Connectwise PHP 客户端。

安装

您可以通过 composer 安装此包

composer require acadea/connectwise-php

将以下环境变量添加到 .env 文件中

CW_COMPANY_ID=
CW_PRIVATEKEY=
CW_PUBLICKEY=

# e.g https://api-au.myconnectwise.net/v4_6_release/apis/3.0/
CW_API_VERSION_BASEURL=
# you can find this at api addr : /v4_6_release/apis/3.0/system/info/locations
CW_HOMEOFFICE_LOCATION=   
CW_CLIENT_ID=

使用方法

轻松使用 API 客户端。请求方法返回 Laravel Collection 对象。

ConnectwiseClient::request('get', 'company/companies');
ConnectwiseClient::request('get', 'company/companies/1');
ConnectwiseClient::request('post', 'company/companies', $payloadArray);
ConnectwiseClient::request('patch', 'company/companies/1', $payloadArray);
ConnectwiseClient::request('delete', 'company/companies/1');

或者使用 Connectwise 类。方便地预加载了 'get', 'create', 'update', 'find', 'delete' 和 'count' 方法

$cw = new Connectwise('company/companies');
$collection = $cw->get([
  'conditions'=> "identifier='XYZTestCompany'"
])

$collection = $cw->update( $id,
  [
      [
          'op' => 'replace',
          'path' => 'phoneNumber',
          'value' => '054684321',
      ],
      [
          'op'   => 'replace',
          'path' => 'city',
          'value' => 'heya',
      ],
  ]

$collection = $cw->delete($id);

$collection = $cw->find($id);

$int = $cw->count($filter);

扩展 Connectwise 类以创建自己的端点客户端

请确保包含 uri 属性以自定义端点。

use Acadea\Connectwise;

class Company extends Connectwise
{
    protected $uri = "company/companies"

    public function getInvoices()
    {
        // ....
    }
}

测试

composer test

变更日志

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

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全性

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

鸣谢

关于我们

Acadea 是一家位于澳大利亚西珀斯的技术公司。我们主要专注于 Web 开发和软件集成!除此之外,我们还教授人们关于技术和编程的知识。

访问我们的网站
联系我们:hello@acadea.com.au

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件