logo

Accessing the API

2 min read

The repairer connect API is used by repairers and integrators supporting these repairers to automate the quotation, authorisation and submission of invoices on to the platform.

The API is available at the following URL:

https://development.{REGION}.aws.helloclaims.com.au/integrations/repairer

The current regions we support are as follows:


Sending a request

In order to successfully access the repairer connect API, you will require an access token, as described here. Once you have obtained an access token, you can issue requests to the API by including the token in the request:

GET https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/{endpoint}
Authorization: "Bearer " + access_token
Content-Type: application/json

By including the token in the request, the API will be able to correctly authenticate the request.


Supported content types

The API supports the following content types, and will respond depending on the Content-Type header specified:

Content TypeHeader value
JSONapplication/json
XMLapplication/xml

Note, you must supply the correct Content-Type header value for the data you send to the API. For example, if you wish to send XML to the API, you will need to specify the Content-Type in your request as follows:

Content-Type: application/xml

The API will then format the response in the same content type you specified for your request.


Response codes

The API conforms to the REST standard, and as such will respond with specific response codes:

CodeDescriptionAdditional data
200Indicates a successful requestNo additional data
201Indicates a resource was created successfullyWill include a location header, specifying the location of the created resource
4XXIndicates a validation failure, or a data issueWill include a response indicating the nature of the error
5XXIndicates a server errorWill include a trace_id header which can be provided to support