smokymountains/ean-client

Client for consuming the EAN Hotel API, based on Guzzle - forked for Guzzle 6.0

Thursday, July 27, 2017
by titani0us
Repository
1 Watchers
0 Stars
4 Installations

PHP
0 Dependents
0 Suggesters
10 Forks
0 Open issues
19 Versions
0 % Grown

The README.md

ean-client

A PHP implementation of the EAN Hotel API., _(*1)

Supports all API requests and both IP and signature authentication. Internally it uses the XML request and response types., _(*2)

, _(*3)

Usage

Each of the API services are represented by a method on the HotelClient object. Each API method takes parameters in a single array argument and returns the results as an array. The parameter names and structure match those of the API spec., _(*4)

A HotelClient object is instantiated using the HotelClient::factory() method, _(*5)

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

use Otg\Ean\HotelClient;

$client = HotelClient::factory([
    'auth' => [
        'cid' => YOUR_CID,
        'apiKey' => YOUR_API_KEY,
        'secret' => YOUR_API_SECRET, // optional, omit if using IP authentication
    ],
    'defaults' => [
        'bookingEndpoint' => 'http://dev.api.ean.com',
        'generalEndpoint' => 'http://dev.api.ean.com',
        'customerIpAddress' => getenv('REMOTE_ADDR'),
        'customerUserAgent' => getenv('HTTP_USER_AGENT'),
    ]
]);

Examples

Hotel List

http://developer.ean.com/docs/hotel-list, _(*6)

$hotels = $client->getHotelList([
    'destinationString' => 'Montpellier France',
    'arrivalDate' => '2016-06-13',
    'departureDate' => '2016-06-27',
    'RoomGroup' => [
       ['numberOfAdults' => 2]
    ]
]);

Room Availability

http://developer.ean.com/docs/room-avail, _(*7)

$rooms = $client->getRoomAvailability([
    'hotelId' => $hotels['HotelList'][0]['hotelId'],
    'arrivalDate' => '2016-06-13',
    'departureDate' => '2016-06-27',
    'RoomGroup' => [
        ['numberOfAdults' => 2]
    ]
]);

Book Reservation

http://developer.ean.com/docs/book-reservation, _(*8)

$bedTypes = $rooms['Rooms'][0]['BedTypes'];
$smokingPreferences = explode(',', $rooms['Rooms'][0]['smokingPreferences']);

$reservation = $client->postReservation([
    'RoomGroup' => [[
        'numberOfAdults' => 2,
        'firstName' => 'Test',
        'lastName' => 'Test',
        'bedTypeId' => key($bedTypes),
        'smokingPreference' => $smokingPreferences[0],
    ]],
    'ReservationInfo' => [
        'email' => 'user@example.org',
        'firstName' => 'Test',
        'lastName' => 'Test',
        'homePhone' => '0312345678',
        'creditCardType' => 'CA',
        'creditCardNumber' => '5401999999999999',
        'creditCardIdentifier' => '123',
        'creditCardExpirationMonth' => '12',
        'creditCardExpirationYear' => '2099'
    ],
    'AddressInfo' => [
        'address1' => 'travelnow',
        'city' => 'travelnow',
        'stateProvinceCode' => 'VC',
        'countryCode' => 'AU',
        'postalCode' => '3000'
    ],
    'hotelId' => $rooms['hotelId'],
    'arrivalDate' => $rooms['arrivalDate'],
    'departureDate' => $rooms['departureDate'],
    'supplierType' => $rooms['Rooms'][0]['supplierType'],
    'rateKey' => $rooms['Rooms'][0]['RateInfos'][0]['RoomGroup'][0]['rateKey'],
    'roomTypeCode' => isset($rooms['Rooms'][0]['roomTypeCode']) ? $rooms['Rooms'][0]['roomTypeCode'] : $rooms['Rooms'][0]['RoomType']['roomCode'],
    'rateCode' => $rooms['Rooms'][0]['rateCode'],
    'chargeableRate' => $rooms['Rooms'][0]['RateInfos'][0]['ChargeableRateInfo']['total'],
    'currencyCode' => $rooms['Rooms'][0]['RateInfos'][0]['ChargeableRateInfo']['currencyCode']
]);

Cancel Reservation

http://developer.ean.com/docs/cancel-reservation, _(*9)

$result = $client->getRoomCancellation([
    'itineraryId' => $reservation['itineraryId'],
    'email' => 'user@example.org',
    'confirmationNumber' => $reservation['confirmationNumbers'][0]
]);

if (isset($result['cancellationNumber'])) {
    printf("Room cancelled: %s", $result['cancellationNumber']);
}

Installation

$ composer require onlinetravelgroup/ean-client

Requirements

PHP 5.4
php5-curl (suggested, unless you want to use a custom adapter)

Contributing

Pull requests are welcome. Just be sure to follow the PSR-1/2 coding standards and don't make a mess., _(*10)

Commit messages should follow the advice at http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html, _(*11)

Messy commits should be squashed until it looks like it was programmed perfectly the first time. This does not necessarily mean a single commit., _(*12)

Diffs should be clean. This means the only lines with changes should be those relevant to the commit message., _(*13)

Running the tests

$ phpunit

Credits

Guzzle does most of the heavy lifting. This project is really just an elaborate Guzzle Services config., _(*14)

License

MIT, _(*15)

The Versions

27/07 2017

dev-master

9999999-dev

Client for consuming the EAN Hotel API, based on Guzzle - forked for Guzzle 6.0

library ean-client

Client for consuming the EAN Hotel API, based on Guzzle - forked for Guzzle 6.0

smokymountains/ean-client

The README.md

ean-client

Usage

Examples

Hotel List

Room Availability

Book Reservation

Cancel Reservation

Installation

Requirements

Contributing

Running the tests

Credits

License

The Versions

dev-master

The Requires

by Ryan Hughes

0.7.5

The Requires

The Development Requires

by Ryan Hughes

0.7.4

The Requires

The Development Requires

by Ryan Hughes

0.7.3

The Requires

The Development Requires

by Ryan Hughes

0.7.2

The Requires

The Development Requires

by Ryan Hughes

0.7.1

The Requires

The Development Requires

by Ryan Hughes

0.7.0

The Requires

The Development Requires

by Ryan Hughes

0.6.0

The Requires

The Development Requires

by Ryan Hughes

0.5.0

The Requires

The Development Requires

by Ryan Hughes

0.4.2

The Requires

The Development Requires

by Ryan Hughes

0.4.1

The Requires

The Development Requires

by Ryan Hughes

0.4.0

The Requires

The Development Requires

by Ryan Hughes

0.3.1

The Requires

The Development Requires

by Ryan Hughes

0.3.0

The Requires

The Development Requires

by Ryan Hughes

v0.2.1

The Requires

by Ryan Hughes

v0.2.0

The Requires

by Ryan Hughes

v0.1.2