Activating Webservices

Activating Propertybase Webservices gives you access to several powerful features like Weblisting Services, WebToProspect, Front Desk and Facebook Lead Ads Integration. This guide is for Propertybase Administrators with a solid understanding of the Salesforce.com platform. Please note that Lightning customers do not need to activate webservices to use Front Desk or related integrations.

Note: You must request an additional (free) site license before activating webservices.

Please email Propertybase support and include your Propertybase ID to request your complimentary site license.


Have your complimentary site license? Wearing your webservices configuration hat? Great - let's get started.

Update Public API Access

Note: If you haven't previously registered a public API site, click here to do that now.

Next, we need to update the access settings for our API site. 

  • Click the gear icon in the top right of the screen, then click Setup.
  • Type 'sites' in the Quick Find menu, then click Sites.
  • Scroll to the bottom of the page and click the name of your PB public API site.
  • From the next page, click Public Access Settings.
  • Under Apps, click Visualforce Page Access.
  • Next to Visualforce Page Access, click Edit.
  • Using the right arrow button (Add), move those selected below to the Enabled column.
  • Click Save.

Next we need to repeat that same process for the Apex Classes.

  • Click the arrow next to Visualforce Page Access, then click Apex Class Access.
  • Next to Apex Class Access, click Edit.
  • Using the right arrow button (Add), move those selected below to the Enabled column.
    • Click Save.

Note: Continue to the next step by scrolling to the top of the page and selecting the next tab.

Modify Object Settings

Next we will make sure all objects have the correct permissions. Setting object permissions invovles checking a lot of boxes. For the next section we will switch to Propertybase classic and install the Salesforce Admin Check All extension for Google Chrome. Once you have installed the extension, continue with the steps below.

  • Click your portrait in the top right corner of the screen and then click Switch to Salesforce Classic.
  • Next click Setup in the top right corner of the screen.
  • Type 'sites' in the Quick Find menu and under Develop, click Sites.
  • In the list of sites, click the name of your PB public API or Webservices site.
  • Click Public Access Settings.
  • Under Apps, click Object Settings.
  • In the list of Object Settings, click Accounts.
  • Click Edit.
  • Copy the settings below for Record Types, Page Layout Assignments and Object Permissions.
  • Under Field Permissions, make sure all fields have Read Access. (You can leave Edit Access at their default values.)

Note: This step is where we use the "check all" box and take advantage of our Chrome extension. 

  • Click Save.
  • Using the arrow next to Accounts, switch to the Contact Object.
  • Click Edit.
  • Copy the settings below for Record Types, Page Layout Assignments and Object Permissions.
  • Under Field Permissions, make sure all fields have Read and Edit Access.
  • Click Save.
  • Using the arrow next to Accounts, switch to the Inquiries Object.
  • Click Edit.

Note: For the remaining objects in this section, we will leave the Record Types and Page Layout Assignments at their defaults. We will only be updating Object Permissions and Field Permissions.

  • Copy the settings below for Object Permissions.
  • Under Field Permissions, make sure all fields have Read and Edit Access.
  • Click Save.
  • Using the arrow next to Accounts, switch to the Linked Listings Object.
  • Click Edit.
  • Copy the settings below for Object Permissions.
  • Under Field Permissions, make sure all fields have Read and Edit Access.
  • Click Save.
  • Using the arrow next to Accounts, switch to the Listings Object.
  • Click Edit.
  • Copy the settings below for Object Permissions.
  • Under Field Permissions, make sure all fields have Read Access. (You can leave Edit Access at their default values.)
  • Click Save.
  • Using the arrow next to Accounts, switch to the Properties Object.
  • Click Edit.
  • Copy the settings below for Object Permissions.
  • Under Field Permissions, make sure all fields have Read Access. (You can leave Edit Access at their default values.)
  • Click Save.
  • Using the arrow next to Accounts, switch to the Property Media Object.
  • Click Edit.
  • Copy the settings below for Object Permissions.
  • Under Field Permissions, make sure all fields have Read Access. (You can leave Edit Access at their default values.)
  • Click Save.
  • Using the arrow next to Accounts, switch to the Settings Object.
  • Click Edit.
  • Copy the settings below for Object Permissions.
  • Under Field Permissions, make sure all fields have Read Access. (You can leave Edit Access at their default values.)
  • Click Save.
  • Using the arrow next to Accounts, switch to the SObject Work Queue Object.
  • Click Edit.
  • Copy the settings below for Object Permissions.
  • Click Save.
  • Using the arrow next to Accounts, switch to the SystemLogs Object.
  • Click Edit.
  • Copy the settings below for Object Permissions.
  • Click Save.
  • Using the arrow next to Accounts, switch to the SystemStructs Object.
  • Click Edit.
  • Copy the settings below for Object Permissions.
  • Click Save.
  • Click your name in the top menu and select Switch to Lightning Experience.

Note: Continue to the next step by scrolling to the top of the page and selecting the next tab.

Assign Propertybase License

Next we will assign a Propertybase license to our new site user, as well as adjust time zone and currency.

  • Click the gear icon in the top right of the screen, then click Setup.
  • Type 'sites' in the Quick Find menu, then click Sites.
  • In the list of sites, click the name of your PB public API or Webservices site.
  • Click Public Access Settings.
  • Click the Assigned Users button.
  • Click Site Guest User, PB public API or Webservices.
  • Click Assign Licenses.
  • Check the box next to Propertybase V3.
  • Click Add.

Note: Continue to the next step by scrolling to the top of the page and selecting the next tab.

Define Endpoint URLs

One of the final steps in configuring webservices is to locate your endpoint URL. The first half of this URL is the domain name of the new webservice site we created and configured in this article. Follow the steps below to locate your endpoint URL.

  • Click the gear icon in the top right of the screen, then click Setup.
  • Type 'sites' in the Quick Find menu, then click Sites.
  • In the list of sites, click the name of your PB public API or Webservices site.

Under Custom URLs, in the Domain Name column, the first half of your endpoint URL will be the second domain listed. In our case this is 'pbexample.secure.force.com'.

The table below lists the second half of the endpoint URL.

Service Name Endpoint URL
Weblistings https://pbexample.secure.force.com/pba__WebserviceListingsQuery
Web To Prospect https://pbexample.secure.force.com/services/apexrest/pba/webtoprospect/v1/

By combining the custom domain we created in this article, with the data in the table above - we get our complete endpoint URLs for the weblistings and web-to-prospect services.

Note: Continue to the next step by scrolling to the top of the page and selecting the next tab.

Generate Tokens

Lastly we need to generate unique tokens and save them as Propertybase settings.

  • Click here to open a free Hash Token Generator. You can use MD5, SHA-1 or SHA-256.
  • Highlight the generated token and then copy to your clipboard.
  • Add Propertybase Settings for both the settings listed below.

Note: Click here to learn how to add settings to Propertybase

Setting Name & Key Setting Value
webserviceListingsQuery_token (the hash token that has been copied to your clipboard)
webserviceWebToProspect_token (the hash token that has been copied to your clipboard)
 
Congratulations! You have successfully activated webservices for your Propertybase account. If you are activating this for Front Desk, send an email to support@propertybase.com with your complete endpoint URL and your tokens, so we can connect your ORG for lead capturing.

At the bottom of this article are some of the features available once you have webservices activated.


Available Webservice Features


FAQs

How do I connect to the endpoint URLs in a sandbox environment?

Endpoint URLs for sandbox accounts should look like this: https://mysandbox-mycompany.cs1.force.com. (Replace 'mycompany' with the custom Force.com domain name you created in this article.)

Powered by Zendesk