Skip to main content

Glossary

TermMeaning
Access tokenThe OAuth 2.0 Bearer token you send on every telemetry call. See Access tokens.
ApplicationYour application in the Developer Portal. It holds your credentials and your API subscriptions.
BatchThe JSON body of one telemetry call: a data object with an array of one or more positions.
Consumer keyYour application's identifier. Your backend sends it with HTTP Basic authentication to the token endpoint. The samples read it from IFMS_CLIENT_ID.
Consumer secretYour 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 PortalThe self-service site at https://apim.kairosinnovations.dev/devportal. You register, create applications, subscribe and get keys there.
DuplicateA 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.
ESBEnterprise Service Bus: the secure API gateway you integrate with. These docs call it the IFMS gateway.
FailureAn 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.
IFMSIntegrated Fleet Management System: the Ministry of Transport and Logistics platform that receives your telemetry.
IFTMS Operator IDYour operator identifier in the national IFTMS. You enter it when you register.
Integration environmentThe 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 windowThe 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.
PositionOne GPS fix for one vehicle at one moment: a plate, a time, a latitude and a longitude.
Production KeysThe consumer key and secret that work with the telemetry API. They are the only keys you use.
Provider codeYour stable provider identity. The gateway takes it from your approved application. You never send it.
Sandbox KeysA second key pair the Developer Portal offers. It does not work with the telemetry API, which has no sandbox endpoint. See Generate keys and get a token.
SubscriptionThe link between your application and the IFMS-Telemetry-Ingest API. Your application must be subscribed before its tokens can call the API. See Subscribe to the telemetry API.
Token endpointThe address your backend calls to get an access token: https://apim.kairosinnovations.dev/oauth2/token.