Getting Started

Start using the Alpinebits-Gateway API

Authentication

In order to use the API-Endpoint, an authentication is required:

A basic username:password authentication method is implemented throughout the endpoint. The credentials need to be provided for every HTTP-Request in form of a Base64-encoded Authorization-Header.
Please note, that your username has access to one single property.

If you require credentials, feel free to contact our support: [email protected]

Endpoint

Following the endpoint where you can send all your requests to:

https://alpinebits-gateway.ando.cloud/api/v1

Request structure

Requests can be sent with the methods GET and POST. Based on the method and the function, some parameters could be additionally sent with the request.

• In case of a GET request, these parameters have to be sent as query parameters with the url
• In case of a POST request, the parameters need to be sent in the request-body and in the JSON-Format. In this case the Content-Type Header needs to be set to application/json

Any mandatory or optional parameters are specified in the single function details below.

Response structure

Successful response

Responses are always returned in the JSON-Format.
By default, all successful responses include a JSON-Object payload a success and a data value. The success value determines the result of the response, while the data value represents the actual response-data.
The data value could be either an object or an array, depending on the requested function. Please find more information in the single function below. The HTTP-Code is 200.
This is how a successful response looks like:

{
  "success": true,
  "data": [...]
}

Unsuccessful response

In case of an unsuccessful response, value of the success variable will be false while the data variable will be replaced by the error variable. This value rappresents a short description of the error. Moreover, the response HTTP-Code will be returned accordingly (400, 401, ...).
This is how an unsuccessful response looks like:

{
  "success": false,
  "error": '...'
}

Functions

Interact with the Alpinebits-Gateway API

syncRoomCapacity ^GET

This request returns the current inventory (number of rooms) for every roomcategory in the system.

Succesful request example

GET https://alpinebits-gateway.ando.cloud/api/v1/syncRoomCapacity?from=2024-02-01&until=2024-02-10&categories=EZ,DZ

HTTP/1.1 200
Content-Type: "application-json; charset=utf-8"
{
  "success": true,
  "data": [
    {
      "day": "2024-02-01",
      "asa_roomcat_code": "EZ",
      "effective_capacity": "3",
      "category_roomcount": "1",
      "category_occupancyrate": "0.00",
      "total_occupancyrate": "50.00"
    },
    {
      "day": "2024-02-01",
      "asa_roomcat_code": "DZ",
      "effective_capacity": "1",
      "category_roomcount": "3",
      "category_occupancyrate": "66.67",
      "total_occupancyrate": "50.00"
    },
    ...
  ]
}

If no start or until date is provided, the default timespan is 30 days starting from today.
Please also note, that for every single combination of day and asa_roomcat_code, a single row will be returned.

syncRate ^GET

This request returns the roomprices for every category and rateplan in the system.

Succesful request example

GET https://alpinebits-gateway.ando.cloud/api/v1/syncRate?from=2024-02-01&until=2024-02-10&categories=EZ,DZ&rateplans=STD_BB
	
HTTP/1.1 200
Content-Type: "application-json; charset=utf-8"
{
  "success": true,
  "data": [
    {
      "day": "2024-02-01",
      "rate": 80,
      "asa_roomcat_code": "EZ",
      "asa_rate_code": "STD_BB",
      "room_type": "EZ",
      "change_datetime": "2024-01-28T10:28:02.048Z"
    },
    {
      "day": "2024-02-01",
      "rate": 110,
      "asa_roomcat_code": "DZ",
      "asa_rate_code": "STD_BB",
      "room_type": "EZ",
      "change_datetime": "2024-01-28T10:28:02.029Z"
    },
    ...
  ]
}

If no start or until date is provided, the default timespan is 30 days starting from today.
Please also note, that for every single combination of day, asa_roomcat_code, asa_rate_code and room_type, a single row will be returned.

It is very important to notice, that the value 0 has to be interpreted as not available. The value 0 does not mean that the cost is free.

syncAvailability ^GET

This request returns the status of a single roomcategory for every single day.

Succesful request example

GET https://alpinebits-gateway.ando.cloud/api/v1/syncAvailability?from=2024-02-01&until=2024-02-10&categories=EZ,DZ&rateplans=STD_BB
	
HTTP/1.1 200
Content-Type: "application-json; charset=utf-8"
{
  "success": true,
  "data": [
    {
      "day": "2024-02-01",
      "asa_roomcat_code": "DZ",
      "asa_rate_code": "2TAGE",
      "availability_id": 1,
      "change_datetime": "2024-02-06T10:23:29.886Z"
    },
    {
      "day": "2024-02-01",
      "asa_roomcat_code": "DZ",
      "asa_rate_code": "STD_BB",
      "availability_id": 1,
      "change_datetime": "2024-02-06T10:23:29.717Z"
    },
    {
      "day": "2024-02-01",
      "asa_roomcat_code": "EZ",
      "asa_rate_code": "2TAGE",
      "availability_id": 1,
      "change_datetime": "2024-02-06T10:23:29.871Z"
    },
    {
      "day": "2024-02-01",
      "asa_roomcat_code": "EZ",
      "asa_rate_code": "STD_BB",
      "availability_id": 1,
      "change_datetime": "2024-02-06T10:23:29.693Z"
    },
    ...
  ]
}

If no start or until date is provided, the default timespan is 30 days starting from today.
Please also note, that for every single combination of day, asa_roomcat_code and asa_rate_code, a single row will be returned.

sendReservation ^POST

Use this request to send a new reservation through the system.

Succesful request example

POST https://alpinebits-gateway.ando.cloud/api/v1/sendReservation
Content-Type: "application-json; charset=utf-8"

Body:
{
  "status": "reservation",
  "externalid": "BOOK2413",
  "from": "2024-02-01",
  "until": "2024-02-03",
  "guest": {
    "language": "de",
    "firstname": "Max",
    "lastname": "Mustermann",
    "gender": "m",
    "birthdate": "1980-06-15",
    "address": "Landesstraße 14",
    "city": "München",
    "zipcode": "80538",
    "country": "de",
    "telephone": "+390123444555",
    "email": "[email protected]"
  },
  "rooms": [{
    "category": "SUITE",
    "rateplan": "STD_BB",
    "occupants": {
      "adults": 2,
      "children": [7]
    },
    "total": 580.00
  }],
  "comment": "A room with a nice view please.",
  "deposits": [{
    "type": "card",
    "amount": 120.00
  }],
  "services": [{
    "type": "beverage",
    "code": "COLA",
    "pricing": "per_use",
    "quantity": 1,
    "inclusive": false,
    "total": "3.50",
    "description": "Coca Cola"
  }],
  "utm_source": "google.com",
  "utm_medium": "referral",
  "utm_campaign": "Newsletter April",
  "total": 580.00,
	"forceavailability": "false"
}


HTTP/1.1 200
Content-Type: "application-json; charset=utf-8"
{
  "success": true,
  "data": {
    "id": "114",
    "externalid": "BOOK2413"
  }
}

In case of successful response, the (internal) id and the external id of the reservation (if provided) are returned.

sendRequestForm ^POST

Use this request to send a new booking request through a HTML Form on your website. Please note that no authentication is required for this request.
The expected Content-Type for this request can be either application/json or application/x-www-form-urlencoded (ideal for direct embedding in own website).

Succesful request example

POST https://alpinebits-gateway.ando.cloud/api/v1/sendRequestForm
Content-Type: "application/x-www-form-urlencoded; charset=utf-8"

Form data:
"propertykey": "abc123"
"externalid": "BOOK2413"
"from": "2024-02-01"
"until": "2024-02-03"
"guest_language": "de"
"guest_firstname": "Max"
"guest_lastname": "Mustermann"
"guest_gender": "m"
"guest_birthdate": "1980-06-15"
"guest_address": "Landesstraße 14"
"guest_city": "München"
"guest_zipcode": "80538"
"guest_country": "de"
"guest_telephone": "+390123444555"
"guest_email": "[email protected]"
"room_1_category": "SUITE"
"room_1_rateplan": "STD_BB"
"room_1_total": 580.00
"room_1_adults": 2
"room_1_child_1_age": 7
"room_1_child_2_age": 4
"comment": "A room with a nice view please."
"utm_source": "google.com"
"utm_medium": "referral"
"utm_campaign": "Newsletter April"
"total": 580.00


HTTP/1.1 200
Content-Type: "application-json; charset=utf-8"
{
  "success": true,
  "data": {
    "id": "114",
    "externalid": "BOOK2413"
  }
}

In case of successful response, the (internal) id and the external id of the reservation (if provided) are returned.

getAvailability ^GET

Use this request to retreive availability and rates for specific dates.

Succesful request example

GET https://alpinebits-gateway.ando.cloud/api/v1/getAvailability?room_1_from=2024-05-10&room_1_until=2024-05-12&room_1_adults=2

HTTP/1.1 200
Content-Type: "application-json; charset=utf-8"
{
  "success": true,
  "data": {
    "requestedrooms": [{
      "roomid": 1,
      "from": "2024-05-10",
      "until": "2024-05-12",
      "adults": 2,
      "children": [],
      "categories": [{
        "categorycode": "DZ",
        "categorytitle_de": "Doppelzimmer",
        "categorytitle_it": "Camera doppia",
        "categorytitle_en": "Double Room",
        "minoccupancy": 1,
        "maxoccupancy": 3,
        "availablebycount": {
          "availablecount": 2,
          "availablerateplans": [{
            "rateplancode": "STD_BB",
            "rateplantitle_de": "Standard Rate",
            "rateplantitle_en": "Standard Rate",
            "rateplantitle_it": "Standard Rate",
            "mealplancode": "BB",
            "total": 220,
            "dailyrates": [{
              "date": "2024-05-10",
              "rate": 110
            }, {
              "date": "2024-05-11",
              "rate": 110
            }]
          }]
        },
        "availablethroughout": {
          "availablerooms": [{
            "roomcode": "208"
          }],
          "availablerateplans": [{
            "rateplancode": "STD_BB",
            "rateplantitle_de": "Standard Rate",
            "rateplantitle_en": "Standard Rate",
            "rateplantitle_it": "Standard Rate",
            "mealplancode": "BB",
            "total": 220,
            "dailyrates": [{
              "date": "2024-05-10",
              "rate": 110
            }, {
              "date": "2024-05-11",
              "rate": 110
            }]
          }]
        }
      }]
    }]
  }
}

Please note that all returned rates include taxes; The city tax is not included.