统一/统一-to

v0.17.5 2024-10-01 00:27 UTC

README

SDK 安装

SDK 依赖于 Composer 来管理其依赖项。

要安装 SDK 并将其添加到现有 composer.json 文件中作为依赖项

composer require "unified/unified-to"

SDK 示例用法

示例

declare(strict_types=1);

require 'vendor/autoload.php';

use Unified\Unified_to;
use Unified\Unified_to\Models\Operations;

$security = '<YOUR_API_KEY_HERE>';

$sdk = Unified_to\UnifiedTo::builder()->setSecurity($security)->build();

$request = new Operations\CreateAccountingAccountRequest(
    connectionId: '<id>',
);

$response = $sdk->accounting->createAccountingAccount(
    request: $request
);

if ($response->accountingAccount !== null) {
    // handle response
}

可用的资源和操作

可用方法

账户

会计

活动

apicall

application

applicationstatus

ats

认证

调用

候选人

通道

集合

商业

公司

连接

联系人

CRM

客户

交易

文档

员工

丰富

事件

文件

genai

分组

hris

集成

面试

库存

发票

问题

项目

工作

日志

KMS

lead

link

list

location

登录

营销技术

成员

消息

消息传递

模型

注释

组织

页面

透传

payment

payout

payslip

person

流水线

项目

提示

退款

评分卡

空间

存储

任务

税率

票务

ticketing

timeoff

transaction

uc

unified

webhook

错误处理

在此 SDK 中处理错误应大致符合您的预期。所有操作都返回一个响应对象或抛出异常。

默认情况下,API 错误将引发 Errors\SDKException 异常,该异常具有以下属性

当为操作指定了自定义错误响应时,SDK 也可能抛出相关的异常。您可以在 SDK 文档中相应的 Errors 表中找到有关每个操作的可能的异常类型更多详细信息。例如,createAccountingAccount 方法抛出以下异常

示例

declare(strict_types=1);

require 'vendor/autoload.php';

use Unified\Unified_to;
use Unified\Unified_to\Models\Operations;

$security = '<YOUR_API_KEY_HERE>';

$sdk = Unified_to\UnifiedTo::builder()->setSecurity($security)->build();

try {
    $request = new Operations\CreateAccountingAccountRequest(
        connectionId: '<id>',
    );

    $response = $sdk->accounting->createAccountingAccount(
        request: $request
    );

    if ($response->accountingAccount !== null) {
        // handle response
    }
} catch (Errors\SDKException $e) {
    // handle default exception
    throw $e;
}

服务器选择

服务器选择

按索引选择服务器

您可以通过在初始化 SDK 客户端实例时传递一个服务器索引到 server_idx: int 可选参数来全局覆盖默认服务器。所选服务器然后将作为默认服务器在使用它的操作中使用。此表列出了与可用服务器关联的索引

每个客户端覆盖服务器 URL

默认服务器也可以通过在初始化 SDK 客户端实例时传递一个 URL 到 server_url: str 可选参数来全局覆盖。例如

摘要

Unified.to API:一统天下的 API

目录

成熟度

此 SDK 处于测试阶段,版本之间可能存在破坏性更改,而无需进行主要版本更新。因此,我们建议将使用锁定到特定包版本。这样,您可以每次安装相同的版本,除非您有意寻找最新版本。

贡献

虽然我们重视对此 SDK 的开源贡献,但此库是程序生成的。请随时打开一个 PR 或 Github 问题作为概念证明,我们将尽力将其包含在未来版本中!

SDK 由 Speakeasy 创建