API System

From version 1.5, we build API system for AweBooking. It helps to develop mobile applications based on this API system.
post
Login
https://domain.com/api/v1/login/
This endpoint allows you to login to the system and get the token code
Request
Response
Request
Body Parameters
email
required
string
Email Address
password
required
string
Password. Min length is 6 characters
Response
200: OK
{    
    "status": true,    
    "message": "Success",
    "token_code": "Token Code"  
}
post
Register
https://domain.com/api/v1/register/
This endpoint allows you to register a new user
Request
Response
Request
Body Parameters
first_name
required
string
First Name
last_name
required
string
Last Name
email
required
string
Email Address
password
required
string
Password. Min length is 6 characters
Response
200: OK
{    
    "status": true,    
    "message": "Success"    
}
post
Logout
https://domain.com/api/v1/logout/
This endpoint allows you to logout of the system
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Response
200: OK
{    
    "status": true,    
    "message": "Success"    
}
post
Reset Password
https://domain.com/api/v1/reset-password/
This endpoint allows you to reset the password
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Body Parameters
email
required
string
Email Address
Response
200: OK
{    
    "status": true,    
    "message": "Success"    
}
post
Change Password
https://domain.com/api/v1/change-password/
This endpoint allows you to change the password
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Body Parameters
password
required
string
Password
password_confirmation
required
string
Re-Password
Response
200: OK
{    
    "status": true,    
    "message": "Success"    
}
get
Current User
https://domain.com/api/v1/current-user/
This endpoint allows you to get current user data
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Response
200: OK
{    
    "status": true,
    "message": "Success",     
    "data": [array]    
}
post
Update Profile
https://domain.com/api/v1/update-profile/
This endpoint allows you to update the user profile
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Body Parameters
first_name
optional
string
First Name
last_name
optional
string
Last Name
mobile
optional
string
Mobile Number
location
optional
number
Get data location from enpoint /get-countries
address
optional
string
Address
description
optional
string
Additional Description
Response
200: OK
{    
    "status": true,
    "message": "Success" 
}
get
Countries
https://domain.com/api/v1/countries/
This endpoint allows you get the countries data
Request
Response
Request
​
Response
200: OK
{    
    "status": true,
    "message": "Success",     
    "data": [array]    
}
get
Languages
https://domain.com/api/v1/languages/
This endpoint allows you get the languages data
Request
Response
Request
​
Response
200: OK
{    
    "status": true,
    "message": "Success",     
    "data": [array]    
}
post
Add Review
https://domain.com/api/v1/add-review/
This endpoint allows you to add a new review
Request
Response
Request
Headers
Authorization
optional
string
Bearer <token_code>
Body Parameters
post_id
required
integer
Post ID
post_type
required
string
Supports: posts, home, car, experience
comment_title
required
string
The title of comment
comment_content
required
string
The content of comment
parent_id
optional
integer
Parent ID of this comment. Default is 0
review_star
optional
integer
This field is required if post type is home, car or experience
Response
200: OK
{    
    "status": true,
    "message": "Success"   
}
get
Reviews
https://domain.com/api/v1/reviews/
This endpoint allows you to get list of reviews
Request
Response
Request
Body Parameters
post_id
required
integer
Post ID
post_type
required
string
Supports: post, page, home, car, experience
number
optional
number
Number of items
page
optional
integer
Current page of list review. Default is 1
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "total": number,
    "data": array   
}
get
Posts
https://domain.com/api/v1/posts/
This endpoint allows you to get list of posts
Request
Response
Request
Body Parameters
search
optional
string
Search string
term_slug
optional
string
The term's name
term_ids
optional
array
Array of term ids
term_relation
optional
string
Supports: and, or
number
optional
integer
Number of items
page
optional
integer
Default is 1
status
optional
array
Array of post's status
order_by
optional
string
Supports: post_id, post_title, post_slug, created_at
order
optional
string
Supports: ASC, DESC
lang
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "total": number,
    "data": array   
}
get
Post
https://domain.com/api/v1/post/:id
This endpoint allows you to get post item
Request
Response
Request
Path Parameters
id
required
integer
Post ID
lang
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array   
}
get
Page
https://domain.com/api/v1/page/:id
This endpoint allows you to get page item
Request
Response
Request
Path Parameters
id
required
integer
Post ID
language
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array   
}
get
Search - Home
https://domain.com/api/v1/home/search
This endpoint allows you to get list of homes
Request
Response
Request
Body Parameters
address
optional
string
Address string
lat
optional
number
Latitude code
lng
optional
number
Longtitude code
check_in
optional
string
Date (Y-m-d)
check_out
optional
string
Date (Y-m-d)
check_in_time
optional
string
Date Time (Y-m-d H:i a)
check_out_time
optional
string
Date Time (Y-m-d H:i a)
start_time
optional
string
Time (H:i a)
end_time
optional
string
Time (H:i a)
booking_type
optional
string
Supports: per_night, per_hour
num_adults
optional
integer
Min: 1
num_children
optional
integer
​
num_infants
optional
integer
​
price_filter
optional
string
Format: 0;100
home_type
optional
string
The string is separated by commas (23,24,25)
home_amenity
optional
string
The string is separated by commas (23,24,25)
number
optional
number
Number of items
page
optional
integer
Default is 1
language
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "total": number,
    "results": array
}
get
Filter Data - Home
https://domain.com/api/v1/home/filters
This endpoint allows you to get the filter data
Request
Response
Request
Path Parameters
lang
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Availability  - Home
https://domain.com/api/v1/home/availability/:id
This endpoint allows you to get home availability  - per Night
Request
Response
Request
Path Parameters
id
required
integer
Home ID
Body Parameters
start_time
required
string
Date (Y-m-d)
end_time
required
string
Date (Y-m-d)
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Time Availability - Home
https://domain.com/api/v1/home/time-availability/:id
This endpoint allows you to get home availability - per Hour
Request
Response
Request
Path Parameters
id
required
integer
Home ID
Body Parameters
date
required
string
Date (Y-m-d)
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Price Realtime - Home
https://domain.com/api/v1/home/price-realtime/:id
This endpoint allows you to get real-time price
Request
Response
Request
Path Parameters
id
required
integer
Home ID
Body Parameters
check_in
required
string
Date (Y-m-d)
check_out
required
string
Date (Y-m-d)
start_time
optional
string
Time (H:i a)
end_time
optional
string
Time (H:i a)
number_adult
optional
integer
Number of adult
number_children
optional
integer
Number of children
extra_services
optional
array
Array of extra services
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "price": number,
    "price_html": string
}
get
Single - Home
https://domain.com/api/v1/home/:id
This endpoint allows get home item
Request
Response
Request
Path Parameters
id
required
integer
Post ID
Body Parameters
lang
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Search - Experience
https://domain.com/api/v1/experience/search
 This endpoint allows search experience
Request
Response
Request
Path Parameters
check_in
optional
string
Date (Y-m-d)
check_out
optional
string
Date (Y-m-d)
address
optional
string
Address for search
lat
optional
string
Latitude code
lng
optional
string
Longtitude code
num_adults
optional
integer
Min:1 
num_children
optional
integer
  
num_infants
optional
integer
 
price_filter
optional
string
 Format: 0;100
experience_type
optional
string
 The string separated by comas (23,24,25)
experience_languages
optional
string
 The string separated by comas (22,23,24)
number
optional
integer
 Number of items
page
optional
number
 Number of page
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "total": number,
    "results" => array
}
get
Filter Data - Experience
https://domain.com/api/v1/experience/filters
This endpoint allows get filter data experience
Request
Response
Request
Path Parameters
lang
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Availability - Experience
https://domain.com/api/v1/experience/availability/:id
This end point allow get availability experience
Request
Response
Request
Path Parameters
id
required
string
Post ID
Body Parameters
start_time
required
string
Date (Y-m-d)
end_time
required
string
 Date(Y-m-d)
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Price Realtime - Experience
https://domain.com/api/v1/experience/price-realtime/:id
Request
Response
Request
Path Parameters
id
required
integer
Post ID
Body Parameters
booking_type
optional
string
Includes: date_time, just_date, package 
check_in
required
string
 Date (Y-m-d). Required if booking type is: just_date or package
start_time
required
integer
Timestamp format. Required if booking type is date_time
extra_services
optional
array
 
number_adult
optional
integer
 Number of adult
number_children
optional
integer
 Number of children
number_infant
optional
integer
 Number of infant
tour_package
optional
string
 ID of package
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "total": number,
    "total_html": string,
    "prices": array
}
get
Single - Experience
https://domain.com/api/v1/experience/:id
Request
Response
Request
Path Parameters
id
required
integer
Post ID
Body Parameters
lang
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Search - Car
https://domain.com/api/v1/car/search
This enpoint allow search car
Request
Response
Request
Path Parameters
check_in
optional
string
Date (Y-m-d)
check_out
optional
string
 Date (Y-m-d)
lat
optional
string
 Latitude code
lng
optional
string
 Longtitude code
address
optional
string
Address for search
check_in_time
optional
string
  Time (H:i a)
check_out_time
optional
string
 Time (H:i a)
price_filter
optional
string
 Format: 0;100
car_type
optional
string
 The string separated by comas (22,23,24)
car_feature
optional
string
  The string separated by comas (22,23,24)
number
optional
integer
 Number of items
page
optional
integer
 
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "total": number,
    "results": array
}
get
Filter Data - Car
https://domain.com/api/v1/car/filters
This endpoint allow get car filter data
Request
Response
Request
Body Parameters
lang
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Availability - Car
https://domain.com/api/v1/car/availability/:id
This endpoint allows get car availability
Request
Response
Request
Path Parameters
id
required
integer
Post ID
Body Parameters
start_time
required
string
Date (Y-m-d)
end_time
required
string
Date (Y-m-d) 
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Time Availability - Car
https://domain.com/api/v1/car/time-availability/:id
This endpoint allows get time availability
Request
Response
Request
Path Parameters
id
required
integer
Post ID
Body Parameters
start_date
required
string
Date (Y-m-d)
end_date
required
string
 Date (Y-m-d)
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Price Realtime - Car
https://domain.com/api/v1/car/price-realtime/:id
This endpoint allow get price realtime
Request
Response
Request
Path Parameters
id
required
integer
Post ID
Body Parameters
check_in
required
string
Date (Y-m-d)
check_out
required
string
 Date (Y-m-d)
start_time
required
string
 Time (H:i a)
end_time
required
string
 Time (H:i a)
number
required
integer
 Quantity of car
equipment
optional
array
 Equipment data
insurance_plan
optional
array
 Insurance plan data
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "price": number,
    "price_html": string
}
get
Single - Car
https://domain.com/api/v1/car/:id
This endpoint allows get car item
Request
Response
Request
Path Parameters
id
optional
integer
Post ID
Body Parameters
lang
optional
string
Language code
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
get
Payment Gateways
https://domain.com/api/v1/payment-gateways
This endpoint allows get payment gateways
Request
Response
Request
​
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
post
Add Cart - Home
https://domain.com/api/v1/add-cart
This endpoint allows add home to cart
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Body Parameters
post_type
required
string
home
post_id
required
integer
 Post ID
number_adult
required
integer
 Number adult
number_children
optional
integer
 Number children
number_infant
optional
integer
 Number infant
check_in
required
string
 Date (Y-m-d)
check_out
required
string
 Date (Y-m-d)
start_time
optional
string
 Time (H:i a)
end_time
required
string
 Time (H:i a)
extra_service
required
array
 Extra services
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "cart": array
}
post
Add Cart - Experience
https://domain.com/api/v1/add-cart
This endpoint allows add experience to cart
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Body Parameters
post_type
required
string
experience
post_id
required
integer
 Post ID
check_in
required
string
 Date (Y-m-d)
check_out
required
string
 Date (Y-m-d)
number_adult
required
integer
 Number adult
number_children
optional
integer
 Number children
number_infant
optional
integer
 Number infant
start_time
optional
string
Timestamp
extra_service
optional
array
 Extra services
booking_type
optional
string
 Includes: date_time, just_date, package
tour_package
optional
string
 Id of package
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "cart": array
}
post
Add Cart - Car
https://domain.com/api/v1/add-cart
This endpoint allows add car to cart
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Body Parameters
post_type
required
string
car
post_id
required
integer
 Post ID
check_in
required
string
 Date (Y-m-d)
check_out
required
string
 Date (Y-m-d)
start_time
required
string
 Time (H:i a)
end_time
required
string
 Time (H:i a)
number
required
integer
Quantity of car
equipment
required
array
  Equipment data
insurance_plan
required
array
 Insurance plan data
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "cart": array
}
get
Get Cart
https://domain.com/api/v1/get-cart
This endpoint allows get cart data
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
post
Checkout
https://domain.com/api/v1/checkout
This endpoint allows checkout
Request
Response
Request
Headers
Authorization
required
string
Bearer <token_code>
Body Parameters
first_name
required
string
First name
last_name
required
string
 Last name
email
required
string
 Email
phone
required
string
 Phone
address
required
string
Address
payment
required
string
Payment type (Name of payment gate using to checkout)
payment_status
required
string
Status of order after checkout
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "token_code": string (Token code of order)
}
get
Get Booking Item
https://domain.com/api/v1/booking-detail/:token_code
This endpoint allow get booking detail using token code from checkout api
Request
Response
Request
Path Parameters
token_code
required
string
Token code return from checkout api
Response
200: OK
{    
    "status": true,
    "message": "Success",
    "data": array
}
Child Theme
Changelog
Last updated 4 months ago
API System

postLogin

postRegister

postLogout

postReset Password

postChange Password

getCurrent User

postUpdate Profile

getCountries

getLanguages

postAdd Review

getReviews

getPosts

getPost

getPage

getSearch - Home

getFilter Data - Home

getAvailability - Home

getTime Availability - Home

getPrice Realtime - Home

getSingle - Home

getSearch - Experience

getFilter Data - Experience

getAvailability - Experience

getPrice Realtime - Experience

getSingle - Experience

getSearch - Car

getFilter Data - Car

getAvailability - Car

getTime Availability - Car

getPrice Realtime - Car

getSingle - Car

getPayment Gateways

postAdd Cart - Home

postAdd Cart - Experience

postAdd Cart - Car

getGet Cart

postCheckout

getGet Booking Item

post
Login

post
Register

post
Logout

post
Reset Password

post
Change Password

get
Current User

post
Update Profile

get
Countries

get
Languages

post
Add Review

get
Reviews

get
Posts

get
Post

get
Page

get
Search - Home

get
Filter Data - Home

get
Availability - Home

get
Time Availability - Home

get
Price Realtime - Home

get
Single - Home

get
Search - Experience

get
Filter Data - Experience

get
Availability - Experience

get
Price Realtime - Experience

get
Single - Experience

get
Search - Car

get
Filter Data - Car

get
Availability - Car

get
Time Availability - Car

get
Price Realtime - Car

get
Single - Car

get
Payment Gateways

post
Add Cart - Home

post
Add Cart - Experience

post
Add Cart - Car

get
Get Cart

post
Checkout

get
Get Booking Item
