README

MyCrystalHub API 的 PHP-SDK

用于访问贵公司数据。

使用方法

运行以下命令以通过 Composer 拉取此包

composer require oliveris/sdk-mycrystalhub

将 Crystal 命名空间导入到类中（自动加载）

use Crystal\Crystal;

示例

设置 API 环境

以下示例展示了如果需要访问不同环境的 API，例如预发布环境。默认情况下，它设置为生产环境。

$crystal = new Crystal();
$crystal->setApiEnvironment('staging');

检索所有公司的客户

以下是如何请求检索公司客户的简单示例。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveAllClients();

检索所有公司的报价

以下是如何请求检索公司报价的简单示例。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveAllQuotes();

检索所有公司的任务

以下是如何请求检索公司任务的简单示例。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveAllJobs();

检索所有公司的发票

以下是如何请求检索公司发票的简单示例。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveAllInvoices();

检索所有公司的员工

以下是如何请求检索公司员工的简单示例。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveAllEmployees();

检索单个客户

以下是如何请求检索单个客户的简单示例。

$client_id 变量应该是整数类型。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveClient($client_id);

检索单个报价

以下是如何请求检索单个报价的简单示例。

$quote_ref 变量应该是字符串类型，例如 'QU1/1'。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveQuote($quote_ref);

检索单个任务

以下是如何请求检索单个任务的简单示例。

$job_ref 变量应该是字符串类型，例如 'JO1/1'。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveJob($job_ref);

检索单个发票

以下是如何请求检索单个发票的简单示例。

$invoice_ref 变量应该是字符串类型，例如 'IN1/1'。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveInvoice($invoice_ref);

检索单个员工

以下是如何请求检索单个员工的简单示例。

$employee_id 变量应该是整数类型。

$crystal = new Crystal();
$crystal->setPkToken('{your_company_pk_token}');
$crystal->setSkToken('{your_company_sk_token}');

$crystal->retrieveEmployee($employee_id);

许可协议

MyCrystalHub 是开源软件，使用 MIT 许可协议 许可。