README

安装

获取你偏好的 HTTP 客户端实现

使用以下命令安装最新版本

$ composer require zimmobe/miep-php-api-client

用法

use MaxImmo\ExternalParties\MiepClient;
use MaxImmo\ExternalParties\Client;
use MaxImmo\ExternalParties\JsonResponseEvaluator;
use Http\Client\HttpClient;
use Http\Message\MessageFactory;

$httpClient = new HttpClient(); // Implementation of Interface
$messageFactory =  new MessageFactory(); // Implementation of Interface
$responseEvaluator = new JsonResponseEvaluator();
$apiClient = new Client($httpClient, $messageFactory, $responseEvaluator);
$miepClient = new MiepClient('client_id', 'client_secret', $apiClient);

更多信息： PHP-HTTP

Guzzle 示例

use GuzzleHttp\Client as GuzzleHttpClient;
use GuzzleHttp\Psr7\HttpFactory;
use MaxImmo\ExternalParties\Client;
use MaxImmo\ExternalParties\JsonResponseEvaluator;
use MaxImmo\ExternalParties\MiepClient;

$apiClient = new Client(
    new GuzzleHttpClient(['base_uri' => 'https://ep.max-immo.be']), 
    new HttpFactory(), 
    new JsonResponseEvaluator()
);
$miepClient = new MiepClient('client_id', 'client_secret', $apiClient);

获取可用经纪人列表

$miepClient->getBrokers();

获取指定经纪人的信息

$miepClient->getInformationForBroker('brokerId');

注意：经纪人 ID 是经纪人 MaxImmo URL 的子域。此经纪人 ID 将在前面讨论的可用经纪人列表中提供。

获取经纪人的房地产信息

$miepClient->getRealEstateListForBroker('brokerId');

注意：经纪人 ID 是经纪人 MaxImmo URL 的子域。此经纪人 ID 将在前面讨论的可用经纪人列表中提供。

获取经纪人的房产信息

$miepClient->getPropertyForBroker('brokerId', 1);

注意

• brokerId 是经纪人 MaxImmo URL 的子域。此经纪人 ID 将在前面讨论的可用经纪人列表中提供。
• propertyId 是 Max-immo 房产 ID。此房产 ID 将在前面讨论的可用房产列表中提供。

获取经纪人的项目

$miepClient->getProjectForBroker('brokerId', 'projectId');

注意

• brokerId 是经纪人 MaxImmo URL 的子域。此经纪人 ID 将在前面讨论的可用经纪人列表中提供。
• projectId 是 Max-immo 房产 ID。此项目 ID 将在前面讨论的可用房产列表中提供。

版本控制

此库将遵循经典的 semver 版本控制。主分支将始终跟踪最新发布。

对此库核心的更改和新增功能，将尽最大努力合并回以前的版本。

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。