Website Enquiry API
From Standout Property Manager Wiki Help
Website Enquiry API
The Website Enquiry API lets an external estate-agent website send contact forms, viewing requests, valuation requests and other sales/lettings enquiries directly into Standout's Communications Centre.
This page explains the Standout administrator workflow. The detailed technical specification is maintained inside Standout on the dedicated Developer integration guide page.
Create a website enquiry source
Open:
Administration → Feeds/Portals → Inbound enquiries → Agency website enquiries
- Enter a Source name, for example Main website.
- Choose a Fixed branch if every enquiry from that source belongs to one Standout branch. Otherwise leave Website may specify branch.
- Optionally enter the Website origin as a complete URL origin, for example `https://www.example.co.uk`.
- Click Create website API key.
- Copy the complete key immediately and send it securely to the developer. Standout does not show the complete key again.
Create one source per website, or one per branch where separate keys/routing are useful.
Keep the key server-side
The Website Enquiry API key is a secret.
It must not be placed in browser JavaScript, public HTML, a public Git repository, a mobile app or analytics/error-reporting payloads.
The public website should submit its form to its own server. The website server then makes a server-to-server HTTPS request to Standout.
Give the developer the guide
On the same Inbound enquiries tab, find Website API integration and click Developer integration guide.
The guide includes:
- the correct API endpoint for that Standout installation;
- authentication headers;
- JSON request fields;
- example viewing request;
- PHP and Node.js server-side examples;
- success/duplicate behaviour;
- HTTP error responses;
- retry and security guidance; and
- what Standout does after accepting an enquiry.
PDF and email
The guide can be shared without asking a developer to sign in to Standout.
At the top of the guide:
- click Download PDF to generate the current guide as an A4 PDF; or
- enter the developer's name/email address and click Email PDF.
Standout generates the PDF on the fly from the same content as the web guide and attaches it to the email. It is not a separate manually maintained document.
Manage an existing source
Under Configured website enquiry sources you can see the source name, branch behaviour, key prefix, allowed origin, last lead and enabled status.
- Regenerate key invalidates the old secret and displays the replacement once.
- Disable stops the source accepting new requests.
- Enable reactivates it.
If a key is regenerated, make sure the developer updates the website before leaving the change outstanding.
What appears in Communications Centre
A successful website request creates an inbound communication containing the supplied customer details, enquiry type, message and property link/reference where supplied.
Standout can match the property, match an existing Contact, route the branch and assign the property's negotiator before the item reaches the queue.
See Communications Centre for the staff workflow after the enquiry arrives.