Support

Access to Firestore

Go to Firestore (test) (production)

Finding a booking in Firestore

1. Click the Filter icon

2. Enter field: 

   • You can use of the suggested or

   • Type a different one like issuer.lastName

3. Choose the condition like "equal to"

4. Enter the value

5. Click to Apply

Triggering re-registration

If the guest should open the registration page after a successful registration you can do the following steps:

1. Find the booking entry

2. Remove the registeredAt attribute

Hint: After successful registration JHP writes the info code registered to BEDS24. This flag is not effected by this removal. If you want to resend the after registration email you have to got to BEDS24, remove the flag and redo the auto action. 

Triggering refresh access code

https://f.jobelhome.com/refreshAccessCode?bookingId=12345

Updating registration of a guest

https://f.jobelhome.com/redirectUserToRegPage?bookingId=12345

This can be useful, when the user or the service manager wants to update a registration after the guest has already registered.

Find access in Firestore by booking

In fire store you will find accesses collection. For each and every bookings stored in bookings collection, there should be an access in accesses collection as well.

You can search in accesses by bookingId and find the related access. Pay attention to image below :

After above steps, if there are some accesses found then everything is well and the access (Or accesses if it is multi-property booking) is created for booking. If no accesses were found, something is not correct and development team can be called then for a bug!!

Refresh Access Code

In order to refresh access codes manually, we have an api which can be called via browser. It is not very often to call refresh access code api manually, as it should be done in most cases automatically, but in cases some issues happened and it was needed to be done manually, you can follow below:

The api for test env is : https://f.jobelhome.com/refreshAccessCode

This api will work in 2 ways:

1. If you call it just like above without any changes, it will refresh the access code for all bookings which are not checked out. It will find all bookings and bookingItems which checkOut time is after the time of calling api, and refresh the access code for the booking.

2. In case you only want to refresh one specific booking's access, you should add the bookingId to the api as well. In this case the api will be like:

     https://f.jobelhome.com/refreshAccessCode?bookingId=123456789

    Pay attention that you should replace the 123456789 in mentioned api above, with the real bookingId which you want to       refresh the access for it. If you use an invalid booking id like what is mentioned above, you will get a message which is           mentioning no bookings found with the given booking id which it will remind you about replacing it

Get Access Code

In order to get the access code for one booking, you only need to provide the bookingId with the api mentioned below. This api can not be called via browser as it is a POST api. It should be changed in the future to a GET api which can be called via browser as it will be much easier for support team.

If Support Team needs it to be accessible from browser very soon, please contact development team and we should refactor it very soon.

The api for test env is: https://f.jobelhome.com/getAccessCode?bookingId=123456789

Pay attention that you should replace the 123456789 in mentioned api above, with the real bookingId which you want to get the access for it. If you use an invalid booking id like what is mentioned above, you will get a message which is mentioning no bookings found with the given booking id which it will remind you about replacing it.

And as we have different types for access, this api will handle it and if the booking is with an item which their type does not require any access codes, it will return a message and remind you about it.

Update Static Access Code

You can retrieve or update the static access code of a property using a dedicated API endpoint. This endpoint allows the support team to manage access codes efficiently. The API is accessible via the browser and can be tested using Swagger documentation or Postman collections.

API Overview

• Endpoint for Test Environment:

  • Swagger Documentation: Test Swagger UI

  • Postman Path: jh ➔ access ➔ [DEV]updateStaticCode

• Endpoint for Production Environment:

  • Swagger Documentation: Production Swagger UI

  • Postman Path: jh ➔ access ➔ [PROD] updateStaticCode

Usage

The updateStaticCode API serves two purposes based on the provided input:

1. Retrieving the Current Access Configuration

2. Updating the Static Access Code

Retrieving the Current Access Configuration

• Description: If you call the API without providing the staticCode field in the request body, it will return the current access configuration of the property specified by propertyTechId.

• HTTP Method: PUT

• Endpoint: /updateStaticCode

Updating the Static Access Code

• Description: If you provide the staticCode field in the request body, the API will update the static access code for the specified property. Optionally, you can specify the sequenceNr if the property has multiple static locks configured.

• HTTP Method: PUT

• Endpoint: /updateStaticCode

Accessing the API

Using Swagger Documentation

The API is documented using Swagger (OpenAPI). You can use the Swagger UI to explore the API endpoints, view request and response schemas, and test the API directly from your browser.

• Test Environment:

  • URL: Test Swagger UI

• Production Environment:

  • URL: Production Swagger UI

Steps:

1. Navigate to the appropriate Swagger URL based on the environment.

2. Locate the Access section in the API documentation.

3. Find the PUT /updateStaticCode endpoint.

4. Expand the endpoint to view details.

5. Use the "Try it out" feature to test the API by providing the necessary parameters in the request body.

Using Postman Collection

You can also test the API using the Postman collections available for both environments.

• Test Environment:

  • Postman Path: jh ➔ access ➔ [DEV] updateStaticCode

• Production Environment:

  • Postman Path: jh ➔ access ➔ [PROD] updateStaticCode

Steps:

1. Open Postman and ensure you have access to the jh collection.

2. Navigate to the appropriate environment ([DEV] for Test, [PROD] for Production).

3. Find the updateStaticCode request under the access folder.

4. Open the request and set the necessary parameters in the request body.

5. Send the request and observe the response.

Important Notes

• Valid propertyTechId: Ensure that the propertyTechId you provide corresponds to an existing property. If no property with the specified propertyTechId exists, the API will respond with a NOT_FOUND error.

• Access Type Restrictions: If the property's access type does not support static code updates (e.g., it's not a STATIC_CODE or COMBO lock type), the API will respond with a BAD_REQUEST error indicating that the operation is not supported for the lock type.

• Sequence Number (sequenceNr):

  • If the property has multiple locks (e.g., in a COMBO lock configuration), you can specify which lock to update using the sequenceNr.

  • The sequenceNr must be a number greater than 0.

  • If sequenceNr is not provided, and the property has only one static lock, the API will update that lock.

  • If sequenceNr is invalid or out of range, the API will respond with an error indicating an invalid sequence number.

⚠️ Warning: Updating the Static Code

 If you update the Static access code using this API, please notify the Technical team to update the static access code for that property in the configuration file in the code base. If this is not done, your changes will be overwritten by the previous access code still stored in the configuration file. 

After Check Out

AfterCheckOut api is called after the booking is checked out via Beds24 auto actions. After the function is called, status of Access if Firestore will be changed to DELETED and if it is a Loxone access, then the user will be deleted from Loxone miniserver as well.

The function is also callable via browser with below link:
https://f.jobelhome.com/afterCheckout?bookingId=12345&propertyId=12345

Make sure that you have replaced bookingId and propertyId values with correct one.

Loxone miniservers

For accessing to Loxone applications please use below links:
Wittlingen: dns.loxonecloud.com/504F94A13D5D

DOB52: dns.loxonecloud.com/504F94115F0D

ATTILA75: dns.loxonecloud.com/504F9410292E

When you log in to miniserver as Admin, you will see a button on the left upper corner of the page. (Showed in picture with arrow)

After clicking on it and scrolling to down, you will find a button named User Management. In this part you can see all users and by clicking on each of them all information about the user are available. Also you will be able to change information in case needed.

Push Refresh Booking webhook

This guide outlines the steps to configure the pushRefreshBooking API for a property within Beds24. This API, implemented as a cloud function, ensures that Jobel Home Properties (JHP) receives real-time updates for any changes made to a booking.

The pushRefreshBooking API is called by Beds24 in a "push" manner, meaning that Beds24 actively sends booking updates to JHP as they occur, rather than JHP having to periodically check for changes.

To configure this for a specific property, follow these steps in Beds24:

1. Navigate to Settings: From the main Beds24 dashboard, click on "Settings."

2. Select Properties: Within the Settings menu, choose "Properties."

3. Go to the Access Tab: Select the specific property you wish to configure, and then navigate to the "Access" tab.

4. Update the Booking Webhook URL: Locate the "Booking Webhook" section. In the "URL" field, you need to enter the appropriate pushRefreshBooking webhook URL.

5. Press the Save button 

Important Note: The "URL" field can contain a list of webhooks. You can add multiple webhooks by pressing the "Enter" key and typing the new URL on a new line.

Current pushRefreshBooking Webhook URLs:

• Test Environment: https://test.app.jobelhome.com/pushRefreshBooking

• Production Environment: https://app.jobelhome.com/pushRefreshBooking