Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 2.77 KB

2.-Installation.md

File metadata and controls

60 lines (35 loc) · 2.77 KB

Important: a license is required in order to publish properties to your website.

1. Before you get started

If your customer already has a SweepBright account, you can request the SweepBright API credentials by reaching out to the technical team. You can read more about requesting API access here.

All you have to do is sending an e-mail, and describing the project you're working on.

2. Installing Advanced Custom Fields Pro

  1. Make sure you have Advanced Custom Fields Pro installed on your website
  2. Enable the Advanced Custom Fields Pro plugin and fill in the license key

3. Installing WP SweepBright PRO

  1. Download the latest version of our plugin contacting sales or this direct link.
  2. Rename the folder to from wp-sweepbright-<version> to wp-sweepbright
  3. Move the wp-sweepbright directory into wp-content/plugins
  4. Enable the plugin

Important notice: do not forget to rename the directory (step 2).

4. Configuration

Configuring the SweepBright API credentials

In order for proper testing to work, it's useful to fill in your SweepBright API credentials on beforehand. You can do this on the "Settings" tab of the plugin (see screenshot). Fill in SweepBright's Client ID and Client Secret.

Configuring Google reCaptcha

The plugin is shipped with built-in reCaptcha, which are used for the contact forms. It's important to fill in these keys, in order for the built-in SweepBright contact forms to work.

5. Verifying your website

When you're ready to try out the SweepBright integration, let us know the name of your WordPress installation. We will add it to our whitelist, so your plugin is licensed.

6. Final step: confirming the plugin's webhook to SweepBright

In order to publish properties from SweepBright to your website you need to send the plugin's webhook URL to SweepBright. You can do this by sending an email with the URL below to SweepBright's technical team.

More information about this email can be found here:

https://get.sweepbright.help/en/articles/2529969-request-access-to-our-website-api

The plugin's webhook URL is using the following pattern:

https://yourdomain.com/wp-json/v1/sweepbright/hook

Replace yourdomain.com with your website's (temporarily) URL.

7. That's it!

SweepBright is now connected. You're now ready to go and build your own SweepBright powered website!