Indigo API

The Cardinus.Indigo API v1.0 delivers a simple application interface for your organisation. It allows you to develop a client application that can connect to Indigo and perform certain actions.

It uses the RESTful approach to retrieve, add and update items within the Indigo system using standard HTTP methods.

The API is split into two main sections:

  • Indigo Property API
  • Indigo Insurance API

If you are unsure which section of the API you need to use, please contact the Indigo Cardinus Administration team, who will be able to assist.

To get started, read the documentation for authentication before moving on to the different available endpoints.

Conventions

To keep the development of client applications simple, the API uses the following conventions:

  • The authentication headers must be included in every request.

  • The HTTP method indicates the action being taken.

    Method Purpose
    get Retrieving data only.
    post Creating a new record, or sending advanced filter criteria when retrieving records.
    put Updating an entire record.
    patch Partially updating a record.
    delete Deleting a record.

  • All data sent in the body of a request must be valid JSON, with the content-type header set to application/json in the request.

  • All responses returned by the API that are successful will return as JSON with the content-type header set to application/json in the response. †
  • Errors follow the standards given in RFC7807. See Error responses for details.
  • Dates are UTC time.
  • Unique identifiers in GUID (UUID) format contain hyphens but no brackets. 00000000-0000-0000-0000-000000000000.

† This behaviour can be overridden when running reports by passing through an Accept header in the request. See the Running reports documentation for more information about this feature.

Updates

The API may receive updates in future which add functionality and data. Cardinus will not modify existing endpoints or the existing properties on data models, but potentially may add new properties to the data models returned from and sent to the endpoints.

Important

Ensure that the client JSON parsing logic does not fail upon encountering unexpected properties.

If an update is to be made that will modify the existing properties or endpoints then this will be restricted to new API endpoints which will be available with a version number.