Welcome to the Online Review Manager developer portal. Here you will find APIs which you can use to integrate our system with yours. If you have any questions or concerns, please contact your Account Manager.

 

 

Authentication

Our API uses token authentication. Once your account is created, you will receive a unique API Key. This key is exclusive to your organization. It cannot and should not be shared be shared with other organizations.

Each time a call is made to any of the API end points, you will need to provide your API key.

 

GET : ?api_key=valid-api-key

 

POST : {
  "api_key": "valid-api-key"
}

Responses

Our API returns a response in JavaScript Object Notation (JSON). Each response will be an array and will have at least 2 parameters:

  • status: Indicates the status of the request. Possible values are 'success' and 'error'
  • message: Contains the API call response

An example response can be seen below.

 

{
  "status": "success",
  "message": {
    "reviews": [...]
  }
}

 

Note that message in a success response will always be an object that can be deserialized into an associative array.

 

Errors

Should your request not pass validation, an error will be returned.

 

{
  "status": "error",
  "message": "The email field is required when phone is not present. The phone field is required when email is not present."
}

 

Note that message for an error response will always be a string