Glossary
| Term | Meaning |
|---|---|
| Access token | The OAuth 2.0 Bearer token you send on every telemetry call. See Access tokens. |
| Application | Your application in the Developer Portal. It holds your credentials and your API subscriptions. |
| Batch | The JSON body of one telemetry call: a data object with an array of one or more positions. |
| Consumer key | Your application's identifier. Your backend sends it with HTTP Basic authentication to the token endpoint. The samples read it from IFMS_CLIENT_ID. |
| Consumer secret | Your application's secret, a long-lived credential. Your backend sends it with HTTP Basic authentication to the token endpoint. Keep it private. The samples read it from IFMS_CLIENT_SECRET. |
| Developer Portal | The self-service site at https://apim.kairosinnovations.dev/devportal. You register, create applications, subscribe and get keys there. |
| Duplicate | A position IFMS had already stored. IFMS compares your provider identity, the normalised plate and recorded_at, to the microsecond. A duplicate is not stored again and comes back in failures as DUPLICATE. |
| ESB | Enterprise Service Bus: the secure API gateway you integrate with. These docs call it the IFMS gateway. |
| Failure | An entry in the failures list of a 202 response. There is one for every position that was a duplicate or was rejected. It gives the position's index, an outcome and a reason. |
| IFMS | Integrated Fleet Management System: the Ministry of Transport and Logistics platform that receives your telemetry. |
| Integration environment | The environment you connect to today: the Developer Portal and token endpoint on apim.kairosinnovations.dev, and the telemetry gateway on gw.kairosinnovations.dev. See Environments. |
| Observation window | The times IFMS accepts in recorded_at: from 30 days before IFMS server time to 5 minutes after it. A position outside the window comes back in failures as RECORDED_AT_OUT_OF_RANGE. See The observation window. |
| Position | One GPS fix for one vehicle at one moment: a plate, a time, a latitude and a longitude. |
| Production Keys | The consumer key and secret that work with the provider API. They are the only keys you use. |
| Provider code | Your stable provider identity. The gateway takes it from your approved application. You never send it. |
| Sandbox Keys | A second key pair the Developer Portal offers. It does not work with the provider API, which has no sandbox endpoint. See Generate keys and get a token. |
| Subscription | The link between your application and the IFMS FMS Service Provider Integration API. Your application must be subscribed before its tokens can call the API. See Subscribe to the provider API. |
| Token endpoint | The address your backend calls to get an access token: https://apim.kairosinnovations.dev/oauth2/token. |
Vehicle legality
A legal vehicle is one IFTMS, the Ministry’s vehicle register, says may operate. Verified means the same as legal. IFMS stores positions only for legal vehicles. Refused positions are never stored. For each refusal, the HTTP 202 response lists an entry in failures[] with outcome: REJECTED and a reason. A new plate is first refused as VEHICLE_NOT_CHECKED. See Failure reasons for the three reasons and what to do.