MyGuest Api

Version 2 of the MyGuest API has been created to allow for interconnecting of our existing services into the MyGuest application by creating endpoints to support the creation, updating and retrieval of requests and can be further expanded as scope requires.  Currently the API is designed for internal consumption from other BC services, however endpoints and calls are being written in such a way that they could opened up to third party developers at a later date. 

Test and Production

In test, a chron job will run every 5 min if it's not commented out.  You can watch the queue at https://adminonline-test.bookingcenter.com/myguest_queue.phtml?port=2.  You can see the history at https://adminonline-test.bookingcenter.com/myguest_history.phtml?port=2

Troubleshooting

When a system (System Trigger, MyBooking, AirBnB, etc) places a message to be processed by the API, we view these in the  Que | MyGuest Que where we can see about any errors or pending messages.  This is the place to verify whether a System placed the correct message in or not.  

Once the message is processed, and thus we can verify what took place, we view these in the Logging | MyGuest History. 

Authentication:

All endpoints and calls require authentication in the form of a login and key pair that are defined in the MyGuest app under Connected Apps. The api_login can be defined as either a string, or an integer, however the api_key must always be in UUID format.

If the call method is GET it needs to be included in the url string as shown in the following example

 
https://manage.bookingcenter.com/api/v2/requests/show/2/281?api_login=1123457&api_key=f4f7ca6c-72b7-4b1c-921e-f31243c2b5ce

For all other call methods, it must be included in the request headers

x-api-login: 1123457
x-api-key: f4f7ca6c-72b7-4b1c-921e-f31243c2b5ce

Failure to include valid credentials as described will return a http status code 401 with a response Unauthorized.

Endpoint Routes:

All endpoints are based off the core url of https://manage.bookingcenter.com/api/

Message Structure

Create Request

POST v2/requests/create/{hotelid}

Request Body Parameters within

Example Request

{
  "request": {
    "room": "32",
    "booking_id": "1332025-4X",
    "details": "credit card declined",
    "email": "jchieppa@gmail.com",
    "name": "Joe Banks",
    "phone": "7075551414",
    "rewards_number": null,
	"message_channel": "Airbnb",
    "message_thread": "597470647",
    "guest_notify": false,
    "form_name": "Self Checkin"
  }
}

Example Response

{
    "api_version": "2",
    "status": "Success",
    "requests": {
        "id": 308,
        "room": "32",
        "details": null,
        "property_id": 2,
        "status_id": 1,
        "created_at": "2019-01-14 23:26:21",
        "updated_at": "2019-01-14 23:26:21",
        "category_id": 21,
        "completed_at": null,
        "first_time": 1,
        "staff_id": null,
        "guest_id": 13,
        "booking_id": "1332025-4X",
		"message_channel": "Airbnb",
		"message_thread": "597470647",
        "assigned": null,
        "status": {
            "id": 1,
            "name": "New",
            "created_at": "2014-11-14 02:23:46",
            "updated_at": "2014-11-14 02:23:46"
        },
        "guest": {
            "id": 13,
            "name": "Joe Banks",
            "email": "jchieppa@gmail.com",
            "phone": "7075551414",
            "rewards_number": "0",
            "created_at": "2018-02-07 10:49:28",
            "updated_at": "2019-01-11 22:09:36"
        },
        "staff": null,
        "category": {
            "id": 21,
            "name": "Self Checkin",
            "department_id": 7,
            "created_at": "2019-01-14 22:21:55",
            "updated_at": "2019-01-14 22:21:55",
            "identifier": "21"
        }
    }
}

MyGuest Message Queue

While the Api endpoints can be called directly (and may eventually be by third party developers) we will be utilizing a queue to process actions and keep a history.

MG_MESSAGES Table Schema

MG_PKEY is a sequence MG_PKEY_SEQ

Status Codes

Reserved Types

MyGuest / BookDB Request to Booking Mapping Table

Table Schema