Skip to main content

Getting Started


The Developer API is built using a standards based HTTPS API using JSON as the data-interchange format.

API URIs#

There are two URIs for each state that developers must be aware of, the staging URI and the live URI:

StateURIs
NSWhttps://nsw-api.staging.reiformslive.com.auhttps://nsw.api.reiformslive.com.au
WAhttps://wa-api.staging.reiformslive.com.auhttps://wa.api.reiformslive.com.au
SAhttps://sa-api.staging.reiformslive.com.auhttps://sa.api.reiformslive.com.au
NThttps://nt-api.staging.reiformslive.com.au https://nt.api.reiformslive.com.au
TAShttps://tas-api.staging.reiformslive.com.auhttps://tas.api.reiformslive.com.au
ACThttps://act-api.staging.reiformslive.com.au https://act.api.reiformslive.com.au
QLDhttps://qld-api.staging.reiformslive.com.auhttps://api.realworks.com.au
VIChttps://vic-api.staging.formslive.com.auhttps://vic.api.formslive.com.au
info

Each state uses different usernames and passwords

The "staging" sites are a separate copy of system and is to be used for development purposes. Developers should not be developing their applications using the live api.

SSL#

Due to the sensitive information being transferred between the client and the API, all requests are required to be sent over HTTPS. Any requests made to a non-secure URI will be redirected to equivalent HTTPS URI.

Key#

Before you can start making requests to the API, you will require an API key. This key is unique to your organization/product and must be kept private. Each key is tied to a specific authentication type outlined below and in combination with an end-user token will allow you to authenticate against the API and perform requests on behalf of an end-user.

Register here to request an API Key.

JSON#

Requests and responses from the Developer API use the JSON data-interchange format. This requires all requests to send a content type header of application/json. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, Python, and many others. These properties make JSON an ideal data-interchange language.

HTTP Verbs#

All HTTP requests are made using one of four verbs (GET, PUT, POST, DELETE). Each verb has it's own meaning:

Status CodeDescription
GETRetrieve the specified resource
PUTUpdate the specified resource
POSTCreate the specified resource
DELETEDelete the specified resource

All documented endpoints specify their required HTTP verb.

Responses#

When the API responds to a request, it will return a HTTP status code depending on whether the response was successful or a failure. Any of the following responses can be returned:

Status CodeDescription
200The request was successful
400Bad request, check your input parameters
401Unauthorized, invalid or expired token
403Forbidden, insufficient permissions
404Not Found, the resource could not be found
500Internal Server Error, something went wrong

Deep Linking#

There may be cases where you want to redirect an end-user to the UI application to view or finish a form. For this purpose, you can create a user token and follow the below instructions to link into the application.

  1. Retrieve a user token using the Create User Session end point
  2. Use the table below to determine the base URI for the state you wish to deep link to:
StateURIs
NSWhttps://nsw.staging.reiformslive.com.auhttps://nsw.reiformslive.com.au
WAhttps://wa.staging.reiformslive.com.auhttps://wa.reiformslive.com.au
SAhttps://sa.staging.reiformslive.com.auhttps://sa.reiformslive.com.auhttps://sa.reiformslive.com.au
NThttps://nt.staging.reiformslive.com.auhttps://nt.reiformslive.com.au
TAShttps://tas.staging.reiformslive.com.auhttps://tas.reiformslive.com.au
ACThttps://act.staging.reiformslive.com.auhttps://act.reiformslive.com.au
QLDhttps://qld.staging.reiformslive.com.auhttps://app.realworks.com.au
VIChttps://vic.staging.formslive.com.auhttps://vic.formslive.com.au
  1. Using the following format BASE_URI/?token=TOKEN#PATH to generate your deep link, e.g: