This repo contains the source code and documentation of the back end API of Adventus.
The API is hosted on the following URL:
https://adventus-api.ml/
Every API call is simply appended to the end of the server's URL and the returned results are always in JSON format. Here is a list of officially supported API commands:
-
Finds hotels for a selected destination and returns them sorted by relevance. The parameter keywords is optional and when omitted the returned objects are sorted by overall rating. In case your app doesn't have separate fields for city and country, you can pass "customsearch" as a countryName parameter.
findhotels/*countryName*/*cityName*/*keywords*/ -
Finds restaurants for a selected destionation and [optionally] with given keywords. Works the same way as "findhotels/"
findrestaurants/*countryName*/*cityName*/*keywords*/ -
Creates a new user account with given email, password, first_name and last_name as POST parameters. Returns back the email, first_name and last_name.
register/ -
Signs into a user account with given email and password, as POST parameters. Returns back two strings called access and refresh respectively. The first one is a JWT Access Token (valid for 7 days) that every user-specific API call requires as authorization. The second one is the refresh token which remains unused for now.
api/token/ -
Requests a password reset for a given email as a POST parameter. The user will receive a password reset link in their inbox.
api/password_reset/ -
[Requires JWT Authorization] Provides basic information about the user: first_name, last_name, email, date_joined, and id.
profile/ -
[Requires JWT Authorization] Adds an object to favorites by given obj_id as a POST parameter.
add_to_favourites/ -
[Requires JWT Authorization] Removes an object from favorites by given obj_id as a POST parameter.
remove_from_favourites/ -
[Requires JWT Authorization] Returns a list of hotels that the user has added to their favorites.
favourite_hotels/
...and we have more to come! Stay tuned.