README

简介

Hotelbeds SDK for PHP是一套工具，其主要目的是帮助开发使用Hotelbeds API的PHP应用程序。这是一个在packagist.org仓库上可用的composer库。

https://packagist.org.cn/packages/hotelbeds/hotel-api-sdk-php

逐步指南

https://github.com/hotelbeds-sdk/hotel-api-sdk-php/wiki/Step-by-step-guide-to-start-from-scratch

许可证

本软件依据LGPL v2.1许可证发布。请参阅文件LICENSE以获取具体详情和更多许可证及版权信息。

API文档

http://hotelbeds-sdk.github.io/hotel-api-sdk-php/

安装

使用Composer工具从控制台安装：https://composer.php.ac.cn/download/

composer require hotelbeds/hotel-api-sdk-php

在PHPStorm中使用Composer依赖管理器：http://blog.jetbrains.com/webide/2013/03/composer-support-in-phpstorm/

重要！！！此版本处于dev-master@dev版本，您需要使用以下命令安装

composer require "hotelbeds/hotel-api-sdk-php:dev-master@dev"

测试

在单元测试目录中可以找到不同的测试，可以使用phpunit运行。有不同的测试集：可用性和预订。

.\vendor\bin\phpunit --testsuite availability

此测试套件执行：API状态，在PMI目的地创建可用性，选择一个房间并执行查价和预订。

使用SDK

概述

HotelApiClient类具有不同的方法，实现了各种HotelAPI调用。

可用性
查价
预订确认
预订取消
预订列表
状态

每个方法都有一个参数，是ApiHelper类型，有四种可能类型

可用性
查价
预订
预订列表

每个调用的所有响应都可以使用PHP中的对象或数组迭代。内部将JSON响应结构转换为PHP关联数组。

重要说明

SDK使用具有魔术属性和方法类的类来记录此功能，使用标准的@property，具体说明如下：http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.property.pkg.html SDK执行的不同调用也是通过相同的方法记录的魔术方法，并且取决于IDE是否在使用自动完成时可见。SDK已在PhpStorm上测试和认证，但用户可以使用，始终首选，并且当您考虑自动完成是否将正常工作或否时，这取决于它是否支持"@property"。

确保您已将openssl和curl扩展安装到PHP环境中，并设置了cacerts路径。

使用autoload包含库PSR-4

<?php
require __DIR__ .'/vendor/autoload.php';

use hotelbeds\hotel_api_sdk\HotelApiClient;
use hotelbeds\hotel_api_sdk\model\Destination;
use hotelbeds\hotel_api_sdk\model\Occupancy;
use hotelbeds\hotel_api_sdk\model\Pax;
use hotelbeds\hotel_api_sdk\model\Rate;
use hotelbeds\hotel_api_sdk\model\Stay;
use hotelbeds\hotel_api_sdk\types\ApiVersion;
use hotelbeds\hotel_api_sdk\types\ApiVersions;
use hotelbeds\hotel_api_sdk\messages\AvailabilityRS;

$reader = new Zend\Config\Reader\Ini();
$commonConfig   = $reader->fromFile(__DIR__ . '\config\Common.ini');
$currentEnvironment = $commonConfig["environment"]? $commonConfig["environment"]: "DEFAULT";
$environmentConfig   = $reader->fromFile(__DIR__ . '\config\Environment.' . strtoupper($currentEnvironment) . '.ini');
$cfgApi = $commonConfig["apiclient"];
$cfgUrl = $environmentConfig["url"];

$this->apiClient = new HotelApiClient($cfgUrl["default"],
    $cfgApi["apikey"],
    $cfgApi["sharedsecret"],
    new ApiVersion(ApiVersions::V1_0),
    $cfgApi["timeout"],
    null,
    $cfgUrl["secure"]);

$rqData = new \hotelbeds\hotel_api_sdk\helpers\Availability();
$rqData->stay = new Stay(DateTime::createFromFormat("Y-m-d", "2018-02-01"),
                         DateTime::createFromFormat("Y-m-d", "2018-02-10"));

$rqData->destination = new Destination("PMI");
$occupancy = new Occupancy();
$occupancy->adults = 2;
$occupancy->children = 1;
$occupancy->rooms = 1;

$occupancy->paxes = [ new Pax(Pax::AD, 30, "Mike", "Doe"), new Pax(Pax::AD, 27, "Jane", "Doe"), new Pax(Pax::CH, 8, "Mack", "Doe") ];
$rqData->occupancies = [ $occupancy ];

$availRS = $apiClient->Availability($rqData);

可以使用酒店属性按酒店列表过滤

$rqData->hotels = [ "hotel" => [ 1067, 1070, 1506, ] ];

异常

在本SDK的第一个版本中，有一个异常（HotelSDKException）用于处理服务级别的错误，并捕获服务器发送的用于审计的AuditData类数据。

try {
    $availRS = $apiClient->Availability($rqData);
} catch (\hotelbeds\hotel_api_sdk\types\HotelSDKException $e) {
    $auditData = $e->getAuditData();
    error_log( $e->getMessage() );
    error_log( "Audit remote data = ".json_encode($auditData->toArray()));
    exit();
} catch (Exception $e) {
    error_log( $e->getMessage() );
    exit();
}

可用性

发送可用性请求

   $availRS = $apiClient->Availability($rqData);

在调用可用性方法后，可以使用迭代器迭代结果，也可以以数组形式读取。

可用性响应检查

在使用迭代器迭代所有结果之前，可以使用isEmpty()方法预先检查是否为空响应，此方法避免了实例化所有中间类，如：房间、价格...

if ($availRS->isEmpty()) {
   echo "There are no results!"
}

使用数组

$allResponse = $availRS->hotels->toArray();

返回此数组结构

["hotels" => 
        [ ["code" => 1067,
           "name" => "Gran Melia Victoria",
           ...
           "rooms" => [
                "code" => "DBL.VM",
                "name" => "DOUBLE SEA VIEW",
                "rates" => [ 
                        ["rateKey" => "20160201|20160210|W|1|1067|DBL.VM|ID_B2B_24|RO|BARE|1~2~1|8|N@1102568804",
                         "net"     => 9999.99,
                        ],
                        ...
                ],
           ]
          ],
          ...
]

使用对象迭代器

// Iterate all returned hotels with an Hotel object
foreach ($availRS->hotels->iterator() as $hotelCode => $hotelData)
{
        // Get all hotel data (from Hotel object $hotelData)
        
        // Iterate all rooms of each hotel
        foreach ($hotelData->iterator() as $roomCode => $roomData)
        {
                // Iterate all rate of each room
                foreach($roomData->rateIterator() as $rateKey => $rateData)
                {
                        
                }
        }
}

iivanov / hotel-api-sdk-php

维护者

详细信息