README

PHP 客户端用于 Skarabee Weblink。有关可用的端点和参数的详细信息，请参阅官方文档。

安装

composer require fw4/skarabee-weblink

使用方法

use Skarabee\Weblink\Client;

$client = new Client('username', 'password');

获取出版物列表

使用 getPublicationSummaries 方法获取已发布属性的列表。

$publications = $client->getPublicationSummaries();

可以按更改/创建日期、属性类型和/或共享状态筛选列表。

use Skarabee\Weblink\Enums\PropertyType;

$modified_since = new DateTime('2021-01-01 12:00:00');
$property_types = [
    PropertyType::Transaction,
    PropertyType::Project,
];
$exclude_shared = true;

$publications = $client->getPublicationSummaries($modified_since, $property_types, $exclude_shared);

获取出版物的详细信息

使用 getPublication 方法获取单个出版物的数据。

$publication = $client->getPublication($publication_id);
$bedrooms = $publication->property->numberOfBedrooms;

获取已发布项目列表

使用 getProjectSummaries 方法获取已发布项目的列表。

$projects = $client->getProjectSummaries();

可以按更改/创建日期和/或共享状态筛选列表。

$modified_since = new DateTime('2021-01-01 12:00:00');
$exclude_shared = true;

$projects = $client->getProjectSummaries($modified_since, $exclude_shared);

获取联系信息

使用 getContactInfo 方法获取代理人的联系信息列表。

$info = $client->getContactInfo();

获取用户账户列表

使用 getLogins 方法获取与代理人关联的用户账户列表。

$users = $client->getLogins();

发送联系表单输入

使用 insertContactMes 方法将联系表单输入提交给 Skarabee。该方法没有返回值，但在出错时抛出 InvalidContactMeException。

$client->insertContactMes([
    'FirstName' => 'string',
    'LastName'  => 'string',
    'Comments'  => 'string',
    'Email'     => 'string',
]);

您可以将多个请求包装在一个数组中，以批量提交数据。

$client->insertContactMes([$contact1, $contact2]);

更新出版物状态

使用 feedback 方法提交有关出版物在线可用性的更新。

use Skarabee\Weblink\Enums\FeedbackStatus;

$client->feedback([
    'PublicationID' => $publication_id,
    'Status'        => FeedbackStatus::Available,
    'URL'           => $property_url,
]);