Review Score API

The Reviews & Review Score API can be used to import reviews into your own CMS, or integrate with supported Third Parties. Please note that as of 1st feb 2017 the Reviews & Review Score API cannot be used to display Reviews/Review Scores on public facing websites or other apps, please also note the Reviews & Review Score API are only available to Platinum Service subscribers.

You will need some technical knowledge in order to implement and make use of the API.

Guidelines on the API can be found below:

To request the review score make a GET request to https://api.homecare.co.uk/index.cfm/reviews/scores with the following fields as URL parameters (eg: https://api.homecare.co.uk/index.cfm/reviews/scores?api_key=<api_key>)

api_key (40 character key)

If your GET request is successful, the API will return a status code of 200 with the response in the following format.

Note: the "score_review_count" key contains the amount of reviews relevant to the review score wheras the "all_review_count" is all reviews published.

[
	{
		"name":"A Home Care Agency",
		"county":"Bedfordshire",
		"address_1":"Mead End",
		"address_2":"",
		"postcode":"SG18 8JU",
		"address_3":"",
		"town":"Biggleswade",
		"id":34075,
		"api_key":"XXX"
		"score":8.083,
		"score_review_count":3,
		"all_review_count": 5
	}
]

Some of the error codes you may encounter:

400 ("Validation Failed") The body of the response will contain a JSON string detailing any specific errors.
401 ("Unauthorised") Your API keys are incorrect or you do not have permission to access the specified resource.
404 ("Not Found") The resource you specified was not found. Check the spelling of the API url is correct.