Differences

This shows you the differences between two versions of the page.

--- start [2018/11/15 17:02]
223.206.215.34
+++ start [2020/04/10 08:33]
127.0.0.1 external edit
@@ Line 1: / Line 1: @@
 **Avia Booking API v1.0 Manual**
 To use an API, you have to get an API key from the back office system ([[http://zimmu.com/booking]]) and set a domain origin that call an API.
 **API Authentication**
 In version 1.0 API make authentication via API’s key and domain origin.
 **API Request Method**
 API can use both POST and GET method, then it can pass parameter from JQuery.post() or JQuery.get() or Web form.
 **API output format**
 API will output a data in JSON format as shown below:
@@ Line 20: / Line 24: @@
 Then you can reproduce an output from JSON data to be a web form or show in data table. A code can write in **PHP Curl** or **JQuery Ajax.**
 __**Method Definition**__
-**1. GET_PROVINCE_LIST**
+**1. GET_PROVINCE_LIST**
 get a province list to do a select box for source and destination.
 parameter: {key}&{method}
-**2. GET_STATION**
+**2. GET_STATION**
 after select source or destination province, use this method to get a list of station for source | destination
 parameter: {key}&{method}&{provinceID}&{type}
 {type} = source | destination
-**3. GET_TIME_TABLE**
+**3. GET_TIME_TABLE**
 get a list of trip schedule when we know a source | destination station and date
 parameter: {key}&{method}&{from}&{to}&{date}
+---------------------------------------------------------
 {from} | {to} = source | destination station ID
 {date} format in Y-m-d such as 2018-03-29
-**4. PUT_BOOKING**
+**4. GET_SEAT_PLAN**
+When you selected car and then this method will show the seat of that car you selected before.
+parameter: {key}&{method}&{serviceID}
+---------------------------------------------------------
+{serviceID} = user selected trip
+**5. PUT_BOOKING**
 when user completed a booking data this method will be use to put a booking data back to datacenter
 parameter: {key}&{method}&{serviceID}&{passengerName}&{telNo}&
-{passportNo}&{amoutOfSeat}
+{passportNo}&{email}&{amoutOfSeat}&{serviceCode}
+---------------------------------------------------------
+{serviceID} = user selected trip
+{passengerName} and {telNo} are mandatory
+{passportNo} and {email} are optional
+{amoutOfSeat} = total number of booking seats
+{serviceCode} = payment method (optional)
+default - 00: Credit/Debit Card | PayPal , 02: Counter service
+* this method will output a booking number to use for reference
+**6. PUT_BOOKING_SEAT**
+when user completed a booking data this method will be use to put a booking data back to datacenter.
+The method PUT_BOOKING_SEAT will add the seat data that different from PUT_BOOKING.
+parameter: {key}&{method}&{serviceID}&{passengerName}&{telNo}& {passportNo}&{email}&{amoutOfSeat}&{serviceCode}&{seletedSeat}
+---------------------------------------------------------
+{serviceID} = user selected trip
+{passengerName} and {telNo} are mandatory
+{passportNo} and {email} are optional
+{amoutOfSeat} = total number of booking seats
+{serviceCode} = payment method (optional)
+{seletedSeat} = consist of “{seatName}-{selectionFee}” example “1A-10,2A-10,…”
+default - 00: Credit/Debit Card | PayPal , 02: Counter service
+* this method will output a booking number to use for reference
+**7. CONFIRM_PAYMENT**
+after put a booking data, payment via credit/debit card or PayPal must process in 10 minutes, payment via other method must process before midnight or 4 hours before departure time, otherwise a booking will be cancelled
+parameter: {key}&{method}&{bookingNo}&{process_by}
+---------------------------------------------------------
+{process_by} = payment vendor name (Counter service, PayPal, …)
+* this method will output a record field “success” or “failure”
+**8. GET_BOOKING**
-{serviceID} = user selected, {passportNo} is optional
-{amoutOfSeat} = total number of seat that booking
-*** this method will output a booking number to use for reference**
-**5. GET_BOOKING**
 you can get a booking data via use of booking number to produce a ticket or QR code or send to an user email
 parameter: {key}&{method}&{bookingNo}
+* use a ticket serial number to produce a QR code
+**9. REFUND_BOOKING**
+This Method use for return the ticket. When customer return the ticket the agency will be fee deducted 30 baht.
+parameter:  {key}&{method}&{bookingNo}
+---------------------------------------------------------
+{bookingNo} = booking number
+* this method will return: Data of refunded value and refunded fee.
@@ Line 51: / Line 160: @@
 Code with get_province_list method:
-{{ :รูป_2.jpg?nolink |}}
+{{ :api.jpg?nolink |}}
 To work with other method you can modify a code in line 19 with new method and it’s parameter.
@@ Line 63: / Line 172: @@
 get_time_table method:
-{{ :n.jpg?nolink |}}
+{{ :x.jpg?nolink |}}{{ :a.jpg?nolink |}}
+get_seat_plan method:
+{{:getseatplan_code.jpg?nolink |}}{{ :getseatplan.jpg?nolink |}}
@@ Line 73: / Line 183: @@
 * Note that we will use 1 passenger data for all seats in same booking. If you need passenger data separate to each seat you must put in difference booking number
 {{ :รูป_6.jpg?nolink |}}
+put_booking_seat method:
+{{ :putbookingseat_code.jpg?nolink |}}
+* Note that we will use 1 passenger data for all seats in same booking. If you need passenger data separate to each seat you must put in difference booking number
+{{ :รูป_6.jpg?nolink |}}
 get_booking method:
@@ Line 79: / Line 197: @@
+**API registration requirement please follow the link below**
+__[[https://zimmu.com/api/manual/register]]__

DokuWiki

Site Tools

Differences

Page Tools