Configure Your Service
The guide here represents a typical integration for a common use case such as user login, but does not encompass
all of the ways in which LaunchKey can be used or integrated (e.g. real-time purchase authorization, identity
verification, single sign-on, etc.). Choose an integration approach that works best for your authentication and
authorization needs, and configure your service accordingly.
The final step integration step is to configure your service in such a way that it can interact with
your mobile app to fulfill the authentication and authorization use case(s) relevant to your service (e.g. user
login, transaction approval, etc.). The minimum goals you need to accomplish in this step include:
This guide covers how to configure your service from a high level only. For detailed instruction, consult
your SDK for documentation and examples: Web and Desktop Developer Portal.
Download & Instantiate SDK
The easiest way to integrate your service with the LaunchKey Platform API is to use one of the many SDKs
available: Web and Desktop Developer Portal. SDKs are available in a number of languages. Reference the documentation in the SDK you choose when
following the integration guide here. Once you’ve
downloaded the SDK, instantiate the SDK Client within your service where necessary.
Provide Enable Option & Create Directory User
Typically, you will want to provide your Users with the ability to opt-in to using your Mobile App for authentication
and authorization after they already exist in your service. To accomplish this, follow this simplified guide:
- Within your Service's account center or User settings, provide your Users with an option to enable this feature.
(e.g. a button, link, switch, etc.)
- At this time, your service should instruct the User to download your Mobile App as it will be used in the setup
process and will be necessary for future authentication and authorization.
- Next, your service will need to display a linking code which will allow the User to link their device and become
a registered User within your directory. Linking is accomplished by your User through the LaunchKey Auth
Modal or your Mobile App. Your service needs to display a QR linking code (for quick linking via scan) and/or a
7-character alphanumeric linking code (for Users whom can’t scan a QR code). This is accomplished by passing a
unique and static user identifier (e.g. UUID, User’s primary key ID in database, etc.) from your service to a
Launchkey User creation API call (see SDK documentation). This identifier will be used in the future by
your service to initiate an Auth Request.
- Once the User has successfully linked their device, that User will be registered in your directory,
and your server will receive positive confirmation through a callback.
- Your Application UI should reflect this successful linking and registration in the User’s account center or settings.
In addition to providing the ability to enable this feature, you should also consider providing a mechanism for
disabling this feature.
Configure Service to Send Requests & Receive Responses
Your service will need to account for the ability to use your Mobile App in your login system,
transaction authorization system, or any other system you want to Use your Mobile App for. For example, if
implementing password-less login, your login system will need to account for Users entering only their username to log
in which may mean your service will need to perform a check on the backend to see if the User has enabled this
feature (something you should track). If they have, your service should process the login attempt through LaunchKey
by sending an Auth Request to the User’s mobile device (see SDK documentation regarding Authenticating a
User) rather than processing the authentication locally within your Application as you would with a typical
The LaunchKey Platform SDK provides instruction with how to check the status of Auth Requests. Once you’ve received the
response from the User, your service should take the appropriate action, e.g. log in user and start a session,
approve the transaction, do nothing, etc.
If the purpose of the Auth Request was to start a session for login, your service will also need to
continuously check to see if the User has ended the session remotely from your Mobile App (see
SDK documentation), in which case your service would need to end the session and log the User out.
Provide Backup Login Option - Optional
If using LaunchKey and your Mobile App for password-less login, you may want to consider providing a backup option
for login in case the User does not have access to a linked device or does not have the ability to use their device
due to network, carrier, or other extraneous problems. A common method used in One-Time Password (OTP) implementations
such as Google White Label is to provide the user with a list of single-use passwords which can be used to log in
without their mobile device. These single-use passwords are provided to the user one time upon the user enabling OTP.
This same approach can be taken with LaunchKey. Your Application would need to provide the necessary UI and backend
functionality to use this approach.
Working with the REST API
Use only if not using an SDK.
Please refer to the API documentation.