Skip to main content

Create and Manage Apps

This guide walks you through creating an app in the OpenLynk dashboard, configuring platform settings, and managing API keys needed for SDK integration.

Prerequisites

  • An OpenLynk account with an organization created
  • For iOS configuration: an Apple Developer account with your Bundle ID and Team ID
  • For Android configuration: your app's package name and SHA-256 certificate fingerprint
  • For push notifications: a Firebase project with FCM enabled

Create a New App

  1. Open the Apps page in the dashboard.
  2. Click + New App.
  3. Fill in the required fields:
    • App Name — a display name for your app (e.g., "My Shopping App").
    • App Slug — a unique subdomain for your deep links. For example, entering myapp means your links will be served from myapp.openlynk.to.
  4. Click Create.
warning

The app slug cannot be changed after creation. Choose it carefully, as it becomes part of every deep link URL for this app.

Find Your App ID

Your App ID is displayed on the app detail page after creation. You need this value to initialize the OpenLynk SDK in your mobile app.

  1. Go to Apps and select your app.
  2. The App ID is shown at the top of the app detail page.
  3. Copy it for use in your SDK initialization code.

Configure iOS Settings

  1. Go to your app's Settings tab.
  2. Under iOS Settings, fill in the following:
FieldExampleWhere to Find
Bundle IDcom.example.myappXcode → Target → General
Team IDA1B2C3D4E5Apple Developer → Membership
App Store URLhttps://apps.apple.com/app/id123456789App Store Connect
iOS App ID123456789App Store Connect → App Information
  1. Click Save.
tip

Once you save your iOS settings, OpenLynk automatically generates and serves the Apple App Site Association (AASA) file at https://YOUR_APP_SLUG.openlynk.to/.well-known/apple-app-site-association.

Configure Android Settings

  1. Go to your app's Settings tab.
  2. Under Android Settings, fill in the following:
FieldExampleWhere to Find
Package Namecom.example.myappbuild.gradleapplicationId
SHA-256 Fingerprint14:6D:E9:...keytool command or Google Play Console
Play Store URLhttps://play.google.com/store/apps/details?id=com.example.myappGoogle Play Console
  1. Click Save.
note

To get your SHA-256 fingerprint, run:

keytool -list -v -keystore your-keystore.jks -alias your-alias

If you use Google Play App Signing, find the fingerprint under ReleaseSetupApp signing in the Google Play Console.

Set Up Web Domain

The web domain serves as a fallback URL when neither an App Store URL nor a Play Store URL is configured, or when a user opens a deep link on a desktop browser.

  1. Go to your app's Settings tab.
  2. Under General Settings, enter your Web Domain (e.g., https://www.example.com).
  3. Click Save.

Generate and Manage SDK API Keys

Every app requires an SDK API key for authentication. The key is used when initializing the OpenLynk SDK in your mobile app.

Generate a New Key

  1. Go to your app's detail page.
  2. Find the SDK API Key card.
  3. Click Generate.
  4. Copy the key immediately.
warning

The API key is only shown once at generation time. Store it securely in your app's configuration or environment variables.

Rotate a Key

Rotating generates a new key and revokes the old one simultaneously.

  1. Go to the SDK API Key card on your app's detail page.
  2. Click Rotate.
  3. Confirm the action.
  4. Copy the new key and update your app's configuration.

Revoke a Key

  1. Go to the SDK API Key card on your app's detail page.
  2. Click Revoke.
  3. Confirm the action.
warning

Revoking an API key immediately invalidates it. Any SDK instances using the revoked key will stop functioning. Make sure you have a replacement key ready before revoking.

Set Up Firebase Credentials

Firebase credentials are required to send push notifications from the OpenLynk dashboard.

  1. Go to the Firebase Console and select your project.
  2. Navigate to Project SettingsService accounts.
  3. Click Generate new private key and download the JSON file.
  4. In the OpenLynk dashboard, go to your app's SettingsFirebase Credentials.
  5. Upload the downloaded JSON file.
  6. Click Test Connection to verify the credentials work.

Verification

After completing setup, confirm the following:

  • Your app appears in the Apps list.
  • iOS settings show your Bundle ID and Team ID.
  • Android settings show your package name and SHA-256 fingerprint.
  • An SDK API key has been generated and copied.
  • The AASA file is accessible at https://YOUR_APP_SLUG.openlynk.to/.well-known/apple-app-site-association (if iOS is configured).
  • Firebase test connection succeeds (if push notifications are needed).

What's Next