README

商业房地产Omnicasa API的PHP客户端。有关使用条款和API凭证，请联系Omnicasa支持并参考官方文档。

安装

composer require fw4/omnicasa-cre

使用方法

use OmnicasaCRE\Omnicasa;
use OmnicasaCRE\Enums\Language;

$api = new Omnicasa('your-secret-key', Language::EN);
$properties = $api->getProperties();

所有端点都作为Omnicasa类的实例方法提供。有关可用端点和响应格式的更多信息，请参阅官方API文档。

可用端点

使用以下方法访问可用端点

$api->getProperties($parameters); // Get basic property list
$api->getProperties($parameters, true); // Get detailed property list
$api->getProperty($id, $parameters);
$api->addPropertyVisit($id, $real_client_ip);
$api->getGoals($parameters);
$api->getPropertyTypes($parameters);
$api->getCities($parameters);
$api->registerPerson($parameters);
$api->contactOnMe($parameters);

分页

返回多个项的端点返回一个可遍历的对象列表。大型列表的分页会自动发生。

$properties = $api->getProperties();

// Traversing over the response takes care of pagination in the background
foreach ($properties as $property) {
    echo $property->id . PHP_EOL;
}

手动分页

对于需要手动分页的情况，提供了一个page方法。调用此方法时，需要提供一个希望获取的页面索引（从0开始）以及每页要获取的项目数量，返回一个可遍历的对象列表。此列表还提供了多种处理分页元数据的方法

• getPage()用于获取当前页面索引（从0开始）。
• getPageSize()用于获取每页的最大项目数。
• count()用于获取当前页上的实际项目数。
• getTotalCount()用于获取所有页面的总项目数。此方法目前在activities端点上不可用。
• getPageCount()用于获取总页数。此方法目前在activities端点上不可用。

示例

$page_index = 2;
$items_per_page = 20;

$properties = $api->getProperties();
$page = $properties->page($page_index, $items_per_page);

echo 'Showing ' . $page->count() . ' items out of ' . $page->getTotalCount() . PHP_EOL;
echo 'Page ' . ($page->getPage() + 1) . ' of ' . $page->getPageCount() . PHP_EOL;
foreach ($page as $property) {
    echo $property->id . PHP_EOL;
}

许可证

fw4/omnicasa-cre遵循MIT许可证（MIT）。有关更多信息，请参阅LICENSE。