Glossary
Anonymous User — A flinkey user created by the partner backend for access purposes, without requiring the end customer to register with flinkey or sign in to the flinkey App. Used in the standard full partner integration model.
API Key / flinkey-API-Key — A partner-specific key from the flinkey Portal, sent as a header on API requests. Not an API Manager credential, SDK Key or Tapkey access token. Must be treated as a secret.
API Manager — A technical account used by the partner backend for server-to-server OAuth authentication (POST /oauth2/token). Credentials must stay in trusted backend systems.
Assignment — Grants a user access to a specific car for a defined time window. Assignment operations may be asynchronous — the final result arrives via webhook.
Assignment Result — The asynchronous outcome of an assignment create, update or delete operation, delivered via webhook.
BLE (Bluetooth Low Energy) — The wireless protocol used by the Tapkey Mobile SDK to communicate locally with the flinkey BLE Box.
Box Command — Custom command data sent to the flinkey BLE Box through the Tapkey Mobile SDK during local BLE access. Used for specific box behavior beyond a simple lock trigger.
Box Feedback / BoxFeedbackV3 — Structured response data from the flinkey BLE Box, including command result, battery state, charging state, drawer state and more.
Car — The vehicle access object in flinkey. The flinkey BLE Box is abstracted behind this concept. Partners work with cars, not directly with boxes.
Customer — The partner’s tenant or account context in flinkey — not the end customer or driver.
Customer-ID — Unique identifier of the partner account within flinkey, retrieved from the Portal.
Digital Key — The mobile access credential used by the Tapkey Mobile SDK to authenticate locally against the flinkey BLE Box. Not the physical vehicle key.
External Reference — A partner-defined identifier used to map partner-side objects (customers, vehicles) to flinkey-side objects (users, cars).
flinkey API — The REST API used by partner backends to manage customer context, cars, users, assignments and related resources.
flinkey App — The flinkey-branded mobile app. Can be used for testing and pilots, but is not the default for full partner integrations.
flinkey BLE Box — The hardware device installed in the vehicle. Contains the original vehicle key and performs the physical lock/unlock action after successful local BLE authentication.
flinkey Portal — Web-based management portal for credentials, webhook configuration and SDK Keys. Available for UAT and PROD.
Idempotency — The property ensuring an operation produces the same result even when executed multiple times. Webhook handlers must be idempotent.
IdToken — A token obtained through the partner backend as part of the mobile access context flow, exchanged for a Tapkey access token.
Keyless Start — Vehicles that detect the keyfob without inserting a physical key blade. May require a KPC adapter for fully digital operation.
KPC Adapter (Keyfob Power Control) — A battery-dummy adapter that lets the flinkey BLE Box control power to the original keyfob.
Mobile Access Context — The data the partner backend provides to the partner mobile app for local vehicle access via the Tapkey Mobile SDK.
OAuth 2.0 Password Grant — The flinkey API token endpoint uses grant_type=password with API Manager credentials. Only for trusted backend systems.
OData — Query options (filtering, selecting, pagination) supported by selected flinkey API endpoints.
Partner Backend — The server-side system that communicates with the flinkey API, manages access logic and provides mobile access context.
Partner Mobile App — The customer-facing app integrating the Tapkey Mobile SDK for local BLE vehicle access.
Physical Lock ID — The lock identifier used by the Tapkey Mobile SDK. Converted from the flinkey box ID using the WITTE Mobile Library.
PROD — The production environment for live integrations. Credentials and configuration are separate from UAT.
SDK Key — Configuration for the Tapkey Mobile SDK integration, retrieved from the flinkey Portal. Not an API Manager credential.
Tapkey Access Token — Token used by the partner mobile app to log in to the Tapkey Mobile SDK after the IdToken exchange.
Tapkey Mobile SDK — The mobile SDK (Android + iOS) for digital key handling, SDK login, BLE communication and local vehicle access.
UAT (User Acceptance Testing) — The test environment for integration development and validation. Every integration starts on UAT before production access is granted.
Webhook — An HTTPS callback from flinkey to the partner backend, delivering asynchronous event results (especially assignment results).
Webhook Secret — A shared secret for validating incoming webhook requests. Must not be logged or committed.
WITTE Mobile Library — Provides flinkey-specific helpers for box ID conversion, Box Command data building and box feedback parsing on Android and iOS.