KidyTour REST API USER GUIDE

Transcription

1 KidyTour REST API USER GUIDE Version

2 Table of Contents 1. Preface References Terms and acronyms Authorization Usage examples Test access Classifiers module definition Booking module definition

3 1. Preface KidyTour REST API for hotel prices search References 1.2. Terms and acronyms Abbreviation JSON REST API URI Description JavaScript Object Notation is an open-standard file format that uses human-readable text to transmit data objects consisting of attribute value pairs and array data types (or any other serializable value). REpresentational State Transfer is an architectural style that defines a set of constraints and properties based on HTTP. Uniform Resource Identifier is a string of characters used to identify a resource. 3

4 2. Authorization Service uses OAuth 2.0 Client Credentials based authorization scheme. Received access token should be added to requests header. Parameter Access Token URL Grant Type Client ID Client Secret Value Client Credentials Request KidyTour representative Request KidyTour representative 4

5 3. Usage examples 1. Authorization: curl -k -i -d "grant_type=client_credentials" --user myclientid:myclientsecret Response: "access_token":"in7hmhr7p3cefkmimeklza..","token_type":"bearer","expires_in": Get classifier information: 2.1. Hotels list curl -k -X GET -H "Authorization:Bearer myaccesstoken" -H "Cache-Control:no-cache" Parameter values for hotel service Parameter Sample values code getinfo getroom getboard getpicture getpresentation Hotel code, for example: ABRACH Boolean, for example: true Boolean, for example: true Boolean, for example: true Boolean, for example: true Boolean, for example: true 2.2. Room types curl -k -X GET -H "Authorization:Bearer myaccesstoken" -H "Cache-Control:no-cache" Board types curl -k -X GET -H "Authorization:Bearer myaccesstoken" -H "Cache-Control:no-cache" Accommodation types curl -k -X GET -H "Authorization:Bearer myaccesstoken" -H "Cache-Control:no-cache" 3. Get booking price for specific query 5

6 curl -k -X GET -H "Authorization:Bearer myaccesstoken" -H "Cache-Control:no-cache" 04T00:00:00Z&hotel=GLORIA&nights_from=7&nights_to=7&adults=2&children=0 Parameter values for booking service Parameter arr_city, dep_city hotel checkin, checkin_from, checkin_to nights, nights_from, nights_to Sample values Tourvisio City ID, for example: 2 Vilnius, Lithuania should be used for dep_city 39 Riga, Latvia should be used for dep_city 101 Tallin, Estonia should be used for dep_city 4 Antalia, Turkey should be used for arr_city 20 Hurghada, Egipt should be used for arr_city. Hotel code, for example: ABRACH. Dates for example T00:00:00Z. Integer, for example: 7, 10. price_from, price_to Integer, for example: 1000, 2000 board room Board code, for example DBL Room type code, for example BUNKB adults, children Integer, for example: 1, 0. child01_age, child02_age, child03_age, child04_age get_flight_info Integer, for example 0, 2. Ranges should be from 0 to 14. Boolean, for example: true 6

7 3.1. Test access Test API access can be accessed over: Parameter Value host port Access limitations: 1. Environment data is being refreshed nightly. 2. Result set is limited to 1,000 records per request. 7

8 4. Classifiers module definition "swagger": "2.0", "info": "title": "API for classifiers", "version": "1.0.0", "host": " host:port ", "basepath": "/rds/kidytour/classifiers", "schemes": [ "https" ], "produces": [ "application/json" ], "paths": "/hotel/v1": "get": "responses": "200": "description": "output of the endpoint", "schema": "type": "object", "properties":, "name": "code", 8

9 , "name": "getinfo",, "name": "getroom",, "name": "getboard",, "name": "getpicture",, "name": "getpresentation", 9

10 ] ], "paths": "/board/v1": "get": "responses": "200": "description": "output of the endpoint", "schema": "type": "object", "properties":, "name": "code", ] ], "paths": "/room/v1": 10

11 "get": "responses": "200": "description": "output of the endpoint", "schema": "type": "object", "properties":, "name": "code", ] ], "paths": "/accommodation/v1": "get": "responses": "200": "description": "output of the endpoint", "schema": "type": "object", "properties": 11

12 , "name": "code", ] 5. Booking module definition "swagger": "2.0", "info": "title": "API for Booking", "version": "1.0.0", "host": "host:port", "basepath": "/rds/kidytour/booking", "schemes": [ "http" ], "produces": [ "application/json" ], "paths": "/price/v1": "get": 12

13 "produces": [ "application/json" ], "responses": "200": "description": "output of the endpoint", "schema": "type": "object", "properties":, "name": "dep_city",, "name": "arr_city",, "name": "hotel",, 13

14 "name": "checkin", "pattern": "^\\d4-[01]\\d-[0123]\\dt[012]\\d:[0-5]\\d:[0-5]\\d(.\\d+)?(z ([-+][012]\\d:[0-5]\\d))$",, "name": "checkin_from", "pattern": "^\\d4-[01]\\d-[0123]\\dt[012]\\d:[0-5]\\d:[0-5]\\d(.\\d+)?(z ([-+][012]\\d:[0-5]\\d))$",, "name": "checkin_to", "pattern": "^\\d4-[01]\\d-[0123]\\dt[012]\\d:[0-5]\\d:[0-5]\\d(.\\d+)?(z ([-+][012]\\d:[0-5]\\d))$",, "name": "price_from",, "name": "price_to",, "name": "board", 14

15 , "name": "room",, "name": "adults",, "name": "children",, "name": "child01_age",, "name": "child02_age",, 15

16 "name": "child03_age",, "name": "child04_age",, "name": "nights ",, "name": "nights_from",, "name": "nights_to",, "name": "get_flight_info", 16

17 "pattern": "^\\d4-[01]\\d-[0123]\\dt[012]\\d:[0-5]\\d:[0-5]\\d(.\\d+)?(z ([-+][012]\\d:[0-5]\\d))$", ] 17