Client apps

Permissions: manage_clients

Every action on this page—viewing, creating, editing, deleting, and batch updates—requires this permission.

A client app (or client) is a registered application that connects to ioki Platform’s APIs—for example ioki Passenger App, ioki Vehicle App, or a Platform API integration. Each client has an identifier and name, a platform (iOS, Android, web, or multi-platform), and a type (passenger, driver, or Platform API client), and is associated with a provider and one or more products.

Super Admins manage client apps here, including their API access.

Client app settings

A client app record controls much of the app’s identity and behavior:

  • Identity. Identifier (unique), name, platform, client type, developer, distribution URL, and minimum supported version.
  • API access. Which ioki APIs the client may call: Passenger API, Driver API, Platform API, and Operator API. Each client also has a generated secret used to authenticate its requests.
  • Products and user segments. The products the client can access, the user segments it may use, and its default user segment.
  • Branding and legal overrides. Logo and dark-mode logo, brand color, imprint text, and URLs for terms of service, privacy policy, imprint, help, and the support website, plus a support email and phone number. These override the provider’s defaults for this client.
  • App store data. Android package name and certificate fingerprints, and iOS team, bundle, and Apple identifiers (used for deep links and app-association files), plus whether app-download reporting is enabled.
  • Passenger-app defaults. Default map center and zoom, deep-link scheme, whether external payment is allowed, the verification channels for sign-in and sign-up (and the preferred channel), and support for web account-deletion requests.

The imprint URL is optional at both the provider and client-app level. The ioki Passenger App uses the client app’s imprint URL if one is set, and otherwise falls back to the provider’s. When neither has an imprint URL, the app hides the imprint link wherever it would otherwise appear, including onboarding and registration, the phone-number sign-in screen, and the menu footer. The privacy policy and terms of service links are unaffected.

View client apps

The page lists the registered client apps. Select a client app to open its detailed view.

Create a client app

Create a new client app, providing at least an identifier, name, and platform, then configure the aspects above. A provider and one or more products must be associated with it.

Edit a client app

Open a client app and change any of its settings.

Delete a client app

Delete a client app that is no longer needed.

Update the minimum version for a platform

To roll a minimum supported app version out across many apps at once, use the batch update: choose a platform and set the minimum version for all client apps on that platform in a single step.