api.ezeetechnosys.comeZee Connectivity Portal – eZee Connectivity Portal

eZee Connectivity Portal Menu Connectivity API Home Introduction The API allows you to perform all the operations that you do with our web client. API is built using REST principles which ensures predictable URLs that makes writing applications easy. Our API has predictable, resource-oriented URLs, and uses response codes to indicate API errors. This API follows HTTP rules, enabling a wide range of HTTP clients can be used to interact with the API. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). Our API’s nature are different and so are their responses which support XML, JSON and CSV response formats. To make the API as explorable as possible, we offer separate environment testing for sandbox accounts and live accounts differentiated by hotel codes and API keys. About the eZee Connectivity API The APIs enable Connectivity Partners to send and retrieve data for the properties. They can easily manage rates and availability , bookings , housekeepings , and many other things — all using their own systems. This enables them to build a one-stop store” for their connected properties, allowing property owners to easily manage their information on numerous applications. You can download ready postman collection for test our APIs. Authentication Sandbox Account You need a sandbox account to use the eZee Connectivity API platform. Register here for getting sandbox account. Production Account You need a production account to use the eZee Connectivity API platform. Contact us to get production account information. Basic Authentication Scheme eZee Connectivity APIs use the basic HTTP authentication scheme – which are understood by ready-made HTTP clients. To use our API you must satisfy these prerequisites A valid hotel code. An Authentication Token Authentication Failure The API returns failed authentication attempts. The response body will be different as per nature of API. JSON Sample 1: { "Errors": { "ErrorCode": "602", "ErrorMessage": "Error: Invalid Auth Code. Please enter proper Auth Code." } } JSON Sample 2: { "Errors": { "ErrorCode": "611", "ErrorMessage": "Unauthorized Access: Invalid Auth Code or Hotel Code." } } JSON Sample 3: { "Errors": { "ErrorCode": "614", "ErrorMessage": "Sandbox User Trial Period is expired. So, you can’t access it." } } JSON Sample 4: { "Errors": { "ErrorCode": "612", "ErrorMessage": "Sandbox User Auth Code is inactive." } } Troubleshooting If your requests repeatedly fail authentication, check below concerns: your request includes proper Authorization header your sandbox account credentials are correct you have access to the endpoint you’re calling Contact us in case of queries. Available API Configuration These are basically masters data that many connectivity partners ask for to do mappings with their system. Most of the API’s work as a web service which uses the HTTP protocol. Check Hotel Authentication This API checks authentication and returns hotel information if authentication is valid. The API can return data in XML formats. The web service responds to HTTP POST requests. Show Details End Point URL https://live.ipms247.com/index.php/page/service.pos2pms POST Header Content-Type: application/xml Parameter Name Data Type Description Example auth * VARCHAR(300) Unique Authentication code XXXXXXXXXXXXXXXXX oprn * VARCHAR(150) Use Keyword gethotelinfo” Request ?xml version="1.0" standalone="yes"? request authxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/auth oprngethotelinfo/oprn /request Response Name Data Type Description Example status String Status value will be providedValues: ok, error ok msg String Message result will be providedValues: success or error message success hotelname String Name of Hotel Hotel hotelcode Integer ID of Room xxxx Success ?xml version=’1.0’ standalone=’yes’? response statusok/status msgsuccess/msg hotelnameMega Hills Hotel/hotelname hotelcodexxxx/hotelcode /response Error ?xml version=’1.0’ standalone=’yes’? response statuserror/status msgInvalid Authentication/msg /response Error Codes Errors Description Hotel Code In-Active The Property has been deactivated API Authkey is deactivated The Authcode/Key has been deactivated Invalid Authentication Invalid data Bad Request Invalid Request Parameter Invalid API Request. Don’t have this API access Invalid Request Method POS Connectivity Retrieve Room Information This API provides room types, rate types and rate plans information for a property. The API can return data in JSON formats. The web service responds to HTTP POST requests. Show Details End Point URL https://live.ipms247.com/pmsinterface/pms_connectivity.php POST Header Content-Type: application/json Parameter Name Data Type Description Example Request_Type * – Use Keyword RoomInfo” NeedPhysicalRooms INT(2) If you need Room data, then put it 1”. It is optional 1 / 0 HotelCode * INT(11) Unique Hotel code xxxx AuthCode * VARCHAR(300) Unique Authentication code xxxxxxxxxx Request { "RES_Request": { "Request_Type": "RoomInfo", "NeedPhysicalRooms":1, "Authentication": { "HotelCode": "xxxx", "AuthCode": "xxxxxxxxxxxx" } } } Response Name Data Type Description Example RoomType.ID Integer Unique RoomType ID 1234500000000000001 RoomType.Name String RoomType Name Garden View Studio Room RoomType.Rooms. RoomID Integer Room Unique ID 1234500000000000001 RoomType.Rooms. RoomName String Room Number/Name 101 RateType.ID Integer Unique RateType ID 1234500000000000001 RateType.Name String RateType Name European Plan RatePlan.RatePlanID Integer Unique RatePlan ID 1234500000000000001 RatePlan.Name String RatePlan Name Garden View Studio Room RatePlan.RoomTypeID Integer RoomType ID 1234500000000000001 RatePlan.RoomType String RoomType Name Garden View Studio Room RatePlan.RateTypeID Integer RateType ID 1234500000000000001 RatePlan.RateType String RateType Name European Plan Errors.ErrorCode – Response Error Code 301, 404 etc Errors.ErrorMessage – Generate Response Message Success, Unauthorized Request etc. Success { "RoomInfo": { "RoomTypes": { "RoomType": [ { "ID": "1234500000000000001", "Name": "Sea View Deluxe Room", "Rooms": [ { "RoomID": "1234500000000000001", "RoomName": "101" }, { "RoomID": "1234500000000000002", "RoomName": "102" } }, { "ID": "1234500000000000002", "Name": "Garden View Studio Room", "Rooms": [ { "RoomID": "1234500000000000004", "RoomName": "201" }, { "RoomID": "1234500000000000005", "RoomName": "202" } } ] }, "RateTypes": { "RateType": [ { "ID": "1234500000000000001", "Name": "European Plan" }, { "ID": "1234500000000000002", "Name": "Continental Plan" }, { "ID": "1234500000000000005", "Name": "Indian Plan" } ] }, "RatePlans": { "RatePlan": [ { "RatePlanID": "1234500000000000001", "Name": "Sea View Deluxe Room", "RoomTypeID": "1234500000000000001", "RoomType": "Sea View Deluxe Room", "RateTypeID": "1234500000000000001", "RateType": "European Plan", "RatePlanType": "INDEPENDENT" }, { "RatePlanID": "1234500000000000015", "Name": "Garden View Studio Room", "RoomTypeID": "1234500000000000002", "RoomType": "Garden View Studio Room", "RateTypeID": "1234500000000000001", "RateType": "European Plan", "RatePlanType": "MASTER" } ] } }, "Errors": { "ErrorCode": "0", "ErrorMessage": "Success" } } Error Codes Error Code Error Name 100 Missing required parameters. 500 Error occurred during processing 502 Request Type is missing 101 Hotel Code is missing 102 Authentication Code is missing 301 Unauthorized Request. Please check hotel code and authentication code 302 Unauthorized Request. Integration is not allowed 303 Auth Code is inactive. 201 Unauthorized request.(Request Type) request is not valid for this hotel code 202 Unauthorized request. Hotel code is not active Kiosk Connectivity Open PMS Connectivity Retrieve Hotel Information This API provides the list of hotel information for groups or chains. This is mainly used for displaying data...