You are a developer, and you want to build a custom website with our Website API? Awesome! Let's get started.

Requirements to access our Website API

First, let's check if:

  • You are a web developer who has experience building with APIs;

  • you are working on behalf of a paying SweepBright customer.

All good? Excellent. Let's move on...

How to ask for access

There are three parties involved in this process: the Estate Agency, the Developer and SweepBright. The quickest way to get access is to follow this process:

  1. The Developer creates a new trial account. They also set up a test Webhook URL. This account and this Webhook URL will serve as a test environment.

  2. The Developer sends an email to [email protected] with the subject Request for Website API access for [Estate Agency name]. They put the Estate Agency and [email protected] in CC. Here is a template:

    Hi SweepBright,

    We’re the developer of [Estate Agency name]. Our customer will confirm this in a reply to this e-mail.

    Thank you for sending us your Website API documentation and extending the trial period of our test account: [e-mail address of test account from step 1].
    Can you send us the test credentials to access the SweepBright Website API? This is the test Webhook URL you can use: [url-to-test-webhook]

    Kind regards.

  3. The Estate Agency replies to this e-mail to confirm that the relationship exists. SweepBright cannot continue if this verification step is skipped.

  4. SweepBright will enable access to the Website API and send the credentials for the test account. SweepBright will extend the trial duration of the test account to 90 days.

  5. When development on the test account is done, the Developer sends an email to [email protected] with the subject Request for Final Account Website API credentials for [Estate Agency name]. They put the Estate Agency and [email protected] in CC. Here is a template:

    Hi SweepBright,

    We’re the development agency of [Estate Agency name]. We have finished implementing all the basic requirements. Please check our integration for final approval.

    Please send us the credentials for our final account for:
    - [The Estate Agency commercial name]
    - With the final Webhook URL: [url-to-final-webhook]

    Kind regards.

  6. SweepBright will check if your website works well with the Website API. After a positive check, SweepBright will send the credentials for the final account.

Important notes

  • SweepBright does not provide any training or coaching to Developers who are not Certified Partners. Interested in becoming a Certified Partner? Let us know at [email protected].

  • Please communicate in English.

  • The development of the website and integration with our Website API is entirely the responsibility of the Developer and Estate Agent. SweepBright only provides documentation and access. SweepBright does not provide training.

  • Our sales and customer care team would be happy to recommend you some Certified Partners.

Did this answer your question?