README

这是一个为简化Laravel和基于PHP的应用程序对ConnectWise Manage API的连接请求而创建的包。

警告

此包目前处于开发中。目前不建议在生产环境中使用。

要求

Guzzle 6.3
Laravel 5.7+

安装

Composer 安装

通过终端中的composer安装此包。

composer require codingfoundry/connectwise-manage-api

设置认证环境 (.env 文件)

将以下详细信息添加到您的 .env 环境文件中，并根据需要使用自己的详细信息。此包利用ConnectWise Manage会员认证方法。详细信息请参阅这里。

每个环境变量都是成功连接所必需的。

CW_API_URL=
CW_CLIENT_ID=
CW_API_VERSION=
CW_COMPANY_ID=
CW_API_PUBLIC_KEY=
CW_API_PRIVATE_KEY=

API URL (CW_API_URL)

输入您的Manage URL。对于云或测试服务器，您必须在ConnectWise Manage URL前加上"api-"。

https://api-au.myconnectwise.net
https://api-eu.myconnectwise.net
https://api-na.myconnectwise.net
https://api-staging.myconnectwise.net

客户端ID (CW_CLIENT_ID)

自Manage API 2019.3版本起，每个应用程序都需要客户端ID。有关客户端ID的信息以及如何生成应用程序的客户端ID，请参阅这里。

API版本 (CW_API_VERSION)

默认推荐版本是2019.3，但您可以通过更改此环境变量使用较旧版本。

公司ID (CW_COMPANY_ID)

每个ConnectWise Manage实例都有一个用于登录的公司ID。

公钥 (CW_API_PUBLIC_KEY) & 私钥 (CW_API_PRIVATE_KEY)

公钥是公司ID和公钥的组合。例如

company+PflTy8uZrw9yLoz6

公钥和私钥是从ConnectWise Manage应用程序内部生成的。有关如何创建此账户的说明，请参阅这里。

完整环境示例

CW_API_URL=https://api-na.myconnectwise.net
CW_CLIENT_ID=7a3bedaed-73f0-441b-609c-c65e27aa3e12
CW_API_VERSION=2019.3
CW_COMPANY_ID=company
CW_API_PUBLIC_KEY=company+PflTy8uZrw9yLoz6
CW_API_PRIVATE_KEY=da34naA8Cja39aE1

使用方法

GET 请求

使用ConnectWise Manage API文档中提供的查询字符串参数从ConnectWise Manage API收集数据。此包仅传递ConnectWise提供的用于查询字符串完整性的键。

可接受的查询字符串参数可以在这里找到。

示例 GET 请求

以下是使用外观的GET请求示例

use CodingFoundry\CWManageAPI\CWManageAPI;

CWManageAPI::get('company/companies', [
    'pageSize' => 30,
    'page' => 1,
    'orderBy' => 'chargeToId asc',
    'fields' => 'id,company/name,status'
]);

上面的示例将输出以下查询字符串

https://api-na.myconnectwise.net/company/companies?pageSize=30&page=1&orderBy=company/name%20%asc&fields=id,company/name,status

codingfoundry / connectwise-manage-api

维护者

详细信息