.. meta:: :description: Wired Zak API read guests :keywords: api, pms, zak, kapi, booking, bookings, reservation, reservations, guest, guests, extra, extras, products, product Zak API to read/write properties ******************************** .. _123456: ../kapi/introduction.html#authentication | These APIs allow you to read/write data related to a zak property. | On each examples `123456`_ is used as **api-key** which is sent as *user*. Fetch Rates =========== | This method will return a list of rates related to a given property .. code-block:: html Url: https://kapi.wubook.net/kp/property/fetch_rates ..... Usage Example ------------- Input fields are not necessary. .. tabs:: .. code-tab:: bash curl $ curl -H "x-api-key:123456" https://kapi.wubook.net/kp/property/fetch_rates .. code-tab:: py >>> import requests >>> headers = {'x-api-key':'123456'} >>> response= requests.post('https://kapi.wubook.net/kp/property/fetch_rates', headers = headers) >>> print(response.text) | Response Example ---------------- | **Response** data: For each rate you receive the following fields .. table:: :widths: 200 600 +--------------------------+-------------------------------------------------------------------------------------------+ | **Field name** | **Description** | +==========================+===========================================================================================+ | *id* | Identification number of the zak rate | +--------------------------+-------------------------------------------------------------------------------------------+ | *board* | Board type | +--------------------------+-------------------------------------------------------------------------------------------+ | *currency* | Short code for currency | +--------------------------+-------------------------------------------------------------------------------------------+ | *name* | Name of the zak rate | +--------------------------+-------------------------------------------------------------------------------------------+ | *standard* | Standard flag | +--------------------------+-------------------------------------------------------------------------------------------+ .. code-block:: shell {"data": [{"id": 99, "board": "", "currency": "EUR", "name": "max", "standard": 1}]} | Fetch Rooms =========== | This method will return a list of rooms related to a given property .. code-block:: html Url: https://kapi.wubook.net/kp/property/fetch_rooms ..... Usage example ------------- Input fields are not necessary. .. tabs:: .. code-tab:: bash curl $ curl -H "x-api-key:123456" https://kapi.wubook.net/kp/property/fetch_rooms .. code-tab:: py >>> import requests >>> headers = {'x-api-key':'123456'} >>> response= requests.post('https://kapi.wubook.net/kp/property/fetch_rooms', headers = headers) >>> print(response.text) ..... Response Example ---------------- | **Response** data: For each room you receive the following fields .. table:: :widths: 200 600 +--------------------------+-------------------------------------------------------------------------------------------+ | **Field name** | **Description** | +==========================+===========================================================================================+ | *id* | Identification number of the zak room | +--------------------------+-------------------------------------------------------------------------------------------+ | *id_room_type* | Identification number of the room type | +--------------------------+-------------------------------------------------------------------------------------------+ | *name* | Name of the zak room | +--------------------------+-------------------------------------------------------------------------------------------+ | *tags* | Array of room tags | +--------------------------+-------------------------------------------------------------------------------------------+ .. code-block:: shell {"data": [{"id": 7774, "id_room_type": 101, "name": "101", "tags": ["MM", "KK"]}, {..}, {..}]} | Fetch Room Types ================ .. code-block:: html Url: https://kapi.wubook.net/kp/property/fetch_room_types ..... Usage example ------------- Input fields are not necessary. .. tabs:: .. code-tab:: bash curl $ curl -H "x-api-key:123456" https://kapi.wubook.net/kp/property/fetch_room_types .. code-tab:: py >>> import requests >>> headers = {'x-api-key':'123456'} >>> response= requests.post('https://kapi.wubook.net/kp/property/fetch_room_types', headers = headers) >>> print(response.text) ..... Response Example ---------------- | **Response-data**: return the array of ‘room types of a property’. For each room type you receive the following fields: .. table:: :widths: 200 600 +--------------------------+-------------------------------------------------------------------------------------------+ | **Field name** | **Description** | +==========================+===========================================================================================+ | *id* | Identification number of the zak room typ e | +--------------------------+-------------------------------------------------------------------------------------------+ | *name* | Name of the zak room type | +--------------------------+-------------------------------------------------------------------------------------------+ | *shortname* | Short name of the zak room type | +--------------------------+-------------------------------------------------------------------------------------------+ | *maxprice* | Default price assigned to the room type | +--------------------------+-------------------------------------------------------------------------------------------+ | *occupancy* | Default occupancy of the room type | +--------------------------+-------------------------------------------------------------------------------------------+ **Occupancy** is a dictionary containing following fields: .. table:: :widths: 200 600 +--------------------------+-------------------------------------------------------------------------------------------+ | **Field name** | **Description** | +==========================+===========================================================================================+ | *adults* | Identification number of the zak room | +--------------------------+-------------------------------------------------------------------------------------------+ | *teens* | Identification number of the room type | +--------------------------+-------------------------------------------------------------------------------------------+ | *children* | Name of the zak room | +--------------------------+-------------------------------------------------------------------------------------------+ | *babies* | Default occupancy of the room type | +--------------------------+-------------------------------------------------------------------------------------------+ .. code-block:: shell {"data": [{"id": 55, "name": "example_name", "shortname": "ex_name", "maxprice": 100.0, "occupancy": {"adults": 2, "children": 1, "teens": 1, "babies": 0}}, {}, {}]} | Fetch Products ============== | This method will return a list of products .. code-block:: html Url: https://kapi.wubook.net/kp/property/fetch_products ..... Usage example ------------- .. tabs:: .. code-tab:: bash curl $ curl -H "x-api-key:123456" https://kapi.wubook.net/kp/property/fetch_products .. code-tab:: py >>> import requests >>> headers = {'x-api-key':'123456'} >>> response= requests.post('https://kapi.wubook.net/kp/property/fetch_products', headers = headers) >>> print(response.text) | Response Example ---------------- | **Response-data**: return the array of ‘products’. For each product you receive the following fields: .. table:: :widths: 200 600 +--------------------------+-------------------------------------------------------------------------------------------+ | **Field name** | **Description** | +==========================+===========================================================================================+ | *id* | Identification number of the zak product | +--------------------------+-------------------------------------------------------------------------------------------+ | *id_zak_property* | Identification of the zak property | +--------------------------+-------------------------------------------------------------------------------------------+ | *id_zak_room_type* | Identification of the zak room type | +--------------------------+-------------------------------------------------------------------------------------------+ | *board* | board type | +--------------------------+-------------------------------------------------------------------------------------------+ | *master* | The main product of the room type, not deletable | +--------------------------+-------------------------------------------------------------------------------------------+ | *max_price* | Default price assigned to the product | +--------------------------+-------------------------------------------------------------------------------------------+ | *name* | Name of the product | +--------------------------+-------------------------------------------------------------------------------------------+ | *rname* | Room Name | +--------------------------+-------------------------------------------------------------------------------------------+ | *rsetups* | Room Setup | +--------------------------+-------------------------------------------------------------------------------------------+ | *srname* | Short room name | +--------------------------+-------------------------------------------------------------------------------------------+ | *occupancy* | Default occupancy for that product | +--------------------------+-------------------------------------------------------------------------------------------+ **Occupancy** is a dictionary containing following fields: .. table:: :widths: 200 600 +--------------------------+-------------------------------------------------------------------------------------------+ | **Field name** | **Description** | +==========================+===========================================================================================+ | *adults* | Identification number of the zak room | +--------------------------+-------------------------------------------------------------------------------------------+ | *teens* | Identification number of the room type | +--------------------------+-------------------------------------------------------------------------------------------+ | *children* | Name of the zak room | +--------------------------+-------------------------------------------------------------------------------------------+ | *babies* | Default occupancy of the room type | +--------------------------+-------------------------------------------------------------------------------------------+ .. code-block:: shell {"data": [{"id": 10, "board": null, "id_zak_property": 10, "id_zak_room_type": 10, "master": 10, "max_price": 1000.0, "name": "CT10", "rname": "CAMERATOP", "rsetups": null, "srname": "CT10", "occupancy": {"adults": 2, "children": 0, "teens": 0, "babies": 0}}, {..}, {..}]} | Fetch Extras ============ | This method will return a list of extras related to a given property .. code-block:: html Url: https://kapi.wubook.net/kp/property/fetch_extras ..... Usage example ------------- .. tabs:: .. code-tab:: bash curl $ curl -H "x-api-key:123456" https://kapi.wubook.net/kp/property/fetch_extras .. code-tab:: py >>> import requests >>> headers = {'x-api-key':'123456'} >>> response= requests.post('https://kapi.wubook.net/kp/property/fetch_extras', headers = headers) >>> print(response.text) | Response Example ---------------- | **Response-data**: return the array of ‘extras’ . For each extra you receive the following fields: .. table:: :widths: auto +--------------------------+-----------------------------------------------------------------------------------------+ | **Field name** | **Description** | +==========================+=========================================================================================+ | *name* | name of the extra | +--------------------------+-----------------------------------------------------------------------------------------+ | *price* | public price of the extra | +--------------------------+-----------------------------------------------------------------------------------------+ | *vat* | VAT (percentage) of the extra | +--------------------------+-----------------------------------------------------------------------------------------+ | *cost* | cost of the extra | +--------------------------+-----------------------------------------------------------------------------------------+ | *tags* | list of tags associated to the extra | +--------------------------+-----------------------------------------------------------------------------------------+ .. code-block:: shell {"data": [{"cost": 2, "name": "Terrestre", "price": 1.0, "tags": [""], "vat": 10.0}, {"cost": 2, "name": "Large", "price": 1000.0, "tags": [""], "vat": 10.0}, {"cost": 2, "name": "Gusto", "price": 500.0, "tags": [""], "vat": 10.0}]}