The Rating Results API
Experience seamless integration with our API (Application Programming Interface). Seamlessly integrate our services into your own applications, websites, or systems to streamline processes, automate tasks, and enhance user experiences.
Introductions
The Client Relationship Consultancy API is organised around OpenAPI. Our API has predictable resource-orientated URLs, accepts JSON encoded bodies and returns JSON encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The API is read-only.
The Client Relationship Consultancy API is versioned. V1 is the current latest version.
Authentication
The Client Relationship Consultancy API uses API keys and secret keys to authenticate requests. Keys will be provided upon request.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via X-API-Key and X-API-Secret headers.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Error
The Client Relationship Consultancy API uses the following conventional HTTP response codes.
200 – OK
Everything worked as expected
400 – Bad Request
The request was unacceptable, often due to missing a required parameter
401 – Unauthorised
Invalid API key and secret key provided
404 – Not Found
The requested resource does not exist
500 – Internal Error
There is a problem on Client Relationship Consultancy’s end which needs to be resolved.
Pagination
Select resources have support for fetching a subset of the data. These are determined by the following headers:
Offset – Fetch all records after the nth record.
Limit – Return n records.
Filtering
Select resources have support for filtering results based on parameters in the URL. E.g. product, round_number and unit type.
Versioning
When backwards incompatible changes are made to the API a new version will be released which is the first parameter of the URL e.g. /api/v1 signifies the version is v1. This is the current latest version.