API URIs
The Forms Live API is available across all Australian states and territories, with each having dedicated staging and production endpoints. This ensures proper separation between development and live environments.
API Endpoints by State
Each state and territory has its own set of API endpoints for both staging (development) and production environments:
| State/Territory | Staging Endpoint | Production Endpoint |
|---|---|---|
| NSW | https://nsw-api.staging.reiformslive.com.au | https://nsw.api.reiformslive.com.au |
| VIC | https://vic-api.formslive-staging.com.au | https://vic.api.formslive.com.au |
| QLD | https://qld-api.staging.reiformslive.com.au | https://api.realworks.com.au |
| SA | https://sa-api.formslive-staging.com.au | https://sa.api.formslive.com.au |
| WA | https://wa-api.staging.reiformslive.com.au | https://wa.api.reiformslive.com.au |
| TAS | https://tas-api.staging.reiformslive.com.au | https://tas.api.reiformslive.com.au |
| NT | https://nt-api.staging.reiformslive.com.au | https://nt.api.reiformslive.com.au |
| ACT | https://act-api.staging.reiformslive.com.au | https://act.api.reiformslive.com.au |
Important: Each state uses different usernames and passwords. API keys and user credentials are state-specific and cannot be used across different states.
Staging vs Production
Staging Environment
The staging sites are separate copies of the system designed for development and testing purposes:
- Purpose: Development, testing, and integration
- Data: Test data only - not connected to live forms or accounts
- Usage: Safe environment for development and debugging
- Recommendation: Always develop against staging first
Production Environment
The production sites contain live data and are used for real estate transactions:
- Purpose: Live, production use
- Data: Real forms, accounts, and transactions
- Usage: Only after thorough testing in staging
- Caution: Never use production for development or testing
curl https://nsw-api.staging.reiformslive.com.au/forms/ \
--request GET \
--header "Authorization: Basic {your-staging-credentials}"
Deep Linking URIs
For deep linking to the Forms Live user interface, each state also has specific base URIs:
| State | Staging UI Base | Production UI Base |
|---|---|---|
| NSW | https://nsw.staging.reiformslive.com.au | https://nsw.reiformslive.com.au |
| VIC | https://vic.formslive-staging.com.au | https://vic.formslive.com.au |
| QLD | https://qld.staging.reiformslive.com.au | https://app.realworks.com.au |
| SA | https://sa.formslive-staging.com.au | https://sa.formslive.com.au |
| WA | https://wa.staging.reiformslive.com.au | https://wa.reiformslive.com.au |
| TAS | https://tas.staging.reiformslive.com.au | https://tas.reiformslive.com.au |
| NT | https://nt.staging.reiformslive.com.au | https://nt.reiformslive.com.au |
| ACT | https://act.staging.reiformslive.com.au | https://act.reiformslive.com.au |
Deep Link Format
Use the following format to create deep links to the Forms Live UI:
BASE_URI/?token=TOKEN#PATH
Where:
- BASE_URI: The appropriate UI base URI from the table above
- TOKEN: A user session token obtained from the Create User Session endpoint
- PATH: The specific page or form you want to link to
# Link to news page (NSW)
https://nsw.reiformslive.com.au/?token=XXX#news
# Link to forms index (TAS)
https://tas.reiformslive.com.au/?token=XXX#forms
# Link to specific form (QLD/Realworks)
https://app.realworks.com.au/?token=XXX#form/123/display
Best Practices
- Always start with staging: Develop and test your integration using staging endpoints
- State-specific credentials: Ensure you're using the correct API key and user tokens for each state
- Environment consistency: Don't mix staging and production credentials or endpoints
- SSL required: All API requests must be made over HTTPS
- Error handling: Implement proper error handling for network and authentication issues