Changes to the API
The telemetry API is version 1, at https://gw.kairosinnovations.dev/api/v1/ingest/telemetry. This page explains how it changes and how to keep your client working when it does.
Controlled changes
IFMS treats these as controlled interface changes, and communicates them before they are enforced:
- the required fields;
- validation ranges;
- authentication;
- what a response means;
- the failure reasons;
- the endpoint path.
Additive changes
Some changes are additive: they add something without breaking what is already there. Build your client so that it keeps working when they arrive.
- New failure reasons. The set of failure
reasoncodes is explicitly additive. Treatreasonandoutcomevalues as plain strings. When you see a value you do not recognise, log it as it is instead of failing. - New response fields. Ignore fields in the response that you do not recognise.
- Request fields. Send only the fields in the contract. IFMS ignores fields it does not recognise, so never rely on one being processed. A provider-specific value does not become a contract field without a formal review.
Use the unversioned address
Post to https://gw.kairosinnovations.dev/api/v1/ingest/telemetry, not to the versioned address some Developer Portal screens show. Send your first batch explains why.
Where to see what changed
- The Changelog lists the changes published to the telemetry API contract.
- The telemetry API reference shows the current contract.
- Sending telemetry describes the fields, limits and failure reasons in full.