marqu3s/octadesk-api

Octadesk API 的 PHP 客户端。

维护者

详细信息

github.com/marqu3s/octadesk-api

源代码

问题

安装: 37

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

v1.0.8 2024-06-26 21:48 UTC

Requires

MIT 1c00986ec39618e5921aa8adf257a1c87070f0ed

  • Joao Marques <joao.woop@jjmf.com>

apihelpbotsupportticketoctadeskwhastapp

This package is auto-updated.

Last update: 2024-08-26 22:08:19 UTC

README

Octadesk API 的 PHP 客户端。

此客户端支持 Octadesk API v0.0.1，并准备支持 v1.0.0。

注意：1.0.0 版本在编写本说明时正在开发中。

使用 GuzzleHttp 包与 API 通信。

用法

要查询 API v0.0.1，请将 OctadeskApi::API_V0 作为客户端构造函数的 $version 参数。

使用 OctadeskApi::API_V1 查询 API v1.0.0。

对于 v0.0.1，您必须通过调用 LoginApi 获取访问令牌，然后在所有请求中使用此访问令牌。将其传递到客户端构造函数中的 $apiToken 参数。请参阅 octadesk 文档。api

对于 v1.0.0，您必须使用在管理员设置下的 Octadesk API 页面生成的令牌。

登录

要获取用户的访问令牌，查询 LoginApi。必须在 Octadesk UI 中的工单设置、集成代码中生成 $apiToken。

$subdomain = "mysubdomainatoctadesk";
$userEmail = "user@domain.com";
$apiToken = "octa.yyyyyyyyyyyy.zzzzzzzzzzzz";

$api = new LoginApi($subdomain, $userEmail);
$accessToken = $api->getAccessToken($apiToken);

工单搜索

$apiUrl = "https://api.octadesk.services";
$userEmail = "user@domain.com";

# The token obtained using LoginApi (to use with v0.0.1). See above.
# Or token generated at Octadesk API page under admin settings (to use with v1.0.0)
$accessToken = "OCTADESK.xxxxxx.xxxxxxx.xxxxxxx";

$api = new TicketsApi($apiUrl, $accessToken, $userEmail, "application/json", OctadeskApi::API_V0);

# Get tickets requested by someone.
$filters = [
  [
    "property" => "requester.id",
    "operator" => OctadeskApi::FILTER_OPERATOR_EQ,
    "value" => $personOctadeskUuid,
  ],
];

$sort = ["property" => "number", "direction" => "desc"];
$page = 1;
$ticketsPerPage = 10;

$response = $api->search($filters, $sort, $page, $ticketsPerPage);