We lean on existing standards where possible in order to simplify integration for clients. We do make additive changes to our API so your application should adopt a permissive approach to parsing responses, ignoring any attributes your client doesn’t understand.
We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a matter/search could not be found, etc.), and codes in the 5xx range indicate an error with our servers.
We can never guarantee 100% uptime for this API, so you will need appropriate failure & retry mechanisms in place, should you receive none 2xx response from the API.
To authenticate your HTTP requests each request must contain header called
x-intouch-o-token. The API key can be generated in the Keys section of the API documentation.
Only HTTPS requests will be accepted.
There are also webhooks available, which enables your InTouch account to trigger external systems.