README

此项目是 onOffice GmbH 支持的 onOffice API 的官方 PHP API 客户端。

• HTTP 协议 用于与 API 通信。
• 使用 访问令牌 和 TLS 连接 确保与 API 的 安全 通信。
• 目标是创建一个 轻量级 客户端，可在其他环境中使用。

目录

• 快速入门示例
• 使用方法
  • 客户端
  • 参数
  • 请求
  • 响应
• API 文档
• 安装
• 贡献
• 许可证

快速入门示例

$sdk = new onOfficeSDK();
$sdk->setApiVersion('stable');

$parametersReadEstate = [
	'data' => [
		'Id',
		'kaufpreis',
		'lage',
	],
	'listlimit' => 10,
	'sortby' => [
		'kaufpreis' => 'ASC',
		'warmmiete' => 'ASC',
	],
	'filter' => [
		'kaufpreis' => [
			['op' => '>', 'val' => 300000],
		],
		'status' => [
			['op' => '=', 'val' => 1],
		],
	],
];

$handleReadEstate = $sdk->callGeneric(onOfficeSDK::ACTION_ID_READ, 'estate', $parametersReadEstate);

$sdk->sendRequests('put the token here', 'and secret here');

var_export($sdk->getResponseArray($handleReadEstate));

查看 示例文件夹 以查看此客户端的可能实现。

使用方法

客户端

onOfficeSDK 负责创建 HTTP 请求并从官方 API 接收 HTTP 响应。

$sdk = new onOfficeSDK();
$sdk->setApiVersion('stable');

请确保您的客户端使用正确的 API 版本。默认情况下，此值设置为 stable。

参数

参数作为 JSON 在 HTTP 请求中传输。客户端在将数组转换为 JSON 之前使用官方的 PHP 数组表示法。

$parametersReadEstate = [
	'data' => [
		'Id',
		'kaufpreis',
		'lage',
	],
	'listlimit' => 10,
	'sortby' => [
		'kaufpreis' => 'ASC',
		'warmmiete' => 'ASC',
	],
	'filter' => [
		'kaufpreis' => [
			['op' => '>', 'val' => 300000],
		],
		'status' => [
			['op' => '=', 'val' => 1],
		],
	],
];

请求

创建对 API 的请求需要 ACTION_ID。onOfficeSDK 类定义了几个可以使用的常量，因此不需要复制这些 ACTION_ID。

需要令牌和密钥才能向 API 发送请求。有关获取这些凭证的信息，请参阅 官方 API 文档。

$handleReadEstate = $sdk->callGeneric(onOfficeSDK::ACTION_ID_READ, 'estate', $parametersReadEstate);

$sdk->sendRequests('put the token here', 'and secret here');

onOfficeSDK::callGeneric 的返回值用于识别等效的响应值。onOfficeSDK::callGeneric 可以在通过 onOfficeSDK::sendRequests 将请求发送到 API 之前多次调用。

响应

使用 onOfficeSDK::getResponseArray 方法检索请求的响应数据。要识别请求的响应，请使用 onOfficeSDK::callGeneric 返回的值。

var_export($sdk->getResponseArray($handleReadEstate));

响应将是一个 PHP 数组。

call 和 callGeneric 之间的区别

此库将提供两种通用方法来创建对 onOffice API 的调用。

• callGeneric 用于创建简单的调用，例如 房地产搜索 或 读取地址
• call 可以用于更具体的特殊 API 请求。一些 API 请求需要一些更多信息才能处理，例如 identifier、resourceId 和 resourceType。这些调用可能类似于 房地产文件 或 编辑地址

有关更多信息，请参阅 API 文档。

API 文档

API 客户端是为最新版本的官方 API 开发的。有关 API 的更多信息，请 在此处 找到。

安装

推荐通过Composer安装此库。 您是Composer新手吗？

这将安装最新支持的版本

$ composer require onoffice/sdk:^0.2.0

有关版本升级的详细信息，请参阅变更日志。

贡献

您想要贡献吗？太好了！

查看我们的贡献规则并开始吧！

许可证

本项目采用MIT许可证。请参阅许可证文件。