AppLink Setup
Here is a detailed guide on configuring the URL Prefix and AppLink. By following these steps, you can easily implement deep linking in your app and track link performance through built-in analytics.
This is the AppLink landing page displayed when no URL prefix is configured.
URL Prefix Setup
You can set up your AppLink using either the default AppsOnAir branded domain or your own custom domain, based on what you prefer.
AppsOnAir Branded Domain Setup (Default)
Enter your desired subdomain in the provided field.Then proceed to Step 2 (Website URL) and Step 3 (App Info). Once completed, your branded domain setup will be ready, and you can start using it to access and generate your AppLinks. if you want to use your own custom domain you can follow custom domain steps.
Custom Domain Setup
Select Yes in the Custom Domain section, then enter your full custom domain in the text field and proceed by clicking Next. Your custom domain is always linked with the AppsOnAir branded domain.
ℹ️ You can start by creating and using a branded domain, and later switch to a custom domain after successful verification. Once the custom domain is verified, only the Website URL and App Info can be edited.
ℹ️ The domain configuration itself (branded or custom) can't be changed after setup.
ℹ️ Ensure the proxy is disabled for your custom domain.
Custom Domain Verification
To complete the setup for using your own domain with AppLink, simply add the required CNAME and TXT records to your domain’s DNS settings. This step verifies your ownership and enables your custom domain to work seamlessly with your links.
- Custom domain verification process may take some time to complete, depending on your domain provider.
- Once you start domain verification, the CNAME and TXT records stay the same for 24 hours for that specific domain and workspace, even if you cancel or restart the process. This helps avoid DNS conflicts.
- If you're using a custom domain for AppLinks, please note that it may take a short time for DNS changes and domain verification to fully propagate. During this period, deep link functionality might not be immediately available, but it will become active shortly after verification is complete.
Domain verification successfully
Once the domain is successfully verified, you'll see the interface shown below. You can now proceed with the next steps by clicking the Next button.
Domain verification failed.
This error appears when your domain hasn’t been verified yet. DNS changes may take time. Please review your setup and try again later.
Setup Website URL
Enter your website URL here. This will be used as the default fallback URL, meaning users will be redirected to this link if no fallback URL is provided during link creation.
Setup Your Apps
Configure your Android and iOS apps by filling in all the required fields, such as Team ID (iOS) and SHA-256 (Android), and other necessary details. This ensures your links work correctly across both platforms.
iOS app configuration
If you have an iOS app, select Yes. You’ll then be asked whether your app is available on the App Store If your app is available, simply search for it using the dropdown and select it. Then, enter the required details to complete the setup.
How to Find Your Apple Team ID
- Log in to your Apple Developer Account.
- Click on the Membership Details tab.
- You’ll find your Team ID listed under the “Team ID” section.
- It’s a 10-character alphanumeric string (e.g., XXXXXXXXXX).
- You can find your Team ID in the Apple Member Center under the provisioning profile
If you don’t have an iOS app, select No in the iOS section. Then, enter the URL where you want iOS users to be redirected when the AppLink is clicked.
If you don’t provide a URL here, users will be redirected to the default fallback URL configured in the previous step.
If your app is not on App Store, select No. You’ll need to manually enter the required details just fill in the fields. The Bundle identifier is a unique identifier for your iOS app and can be found in Xcode under Target > General > Bundle Identifier in the project settings.
Android
Just like with iOS, select whether you have an Android app. If not, enter the fallback URL where users should be redirected when the AppLink is clicked on an Android device.
If you have an Android app, select Yes. You’ll then be asked whether your app is available on the Google Play Store If your app is available, simply search for it using the dropdown and select it. Then, enter the required details to complete the setup.
If your app is not on Play Store, select No. You’ll need to manually enter the required details just fill in the fields. The Package Name uniquely identifies your Android app and can be found in the AndroidManifest.xml or in build.gradle under applicationId.
How to Get Your SHA-256 Fingerprint
1. Using Android Studio
- Open Android Studio.
- Go to View > Tool Windows > Gradle to open the Gradle panel.
- Navigate to: YourApp > Tasks > android > signingReport
- Double-click signingReport.
- Check the Run window for the SHA-256 value.
- Visit this 🔗 page for information on using keytool to get the SHA hash of your signing certificate.
2. Using the Command Line: Use the following command-line instructions to view and get the SHA-256 and other certificate details from your debug or release keystore.
Debug Keystore
keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android
Release Keystore
keytool -list -v -keystore path/to/your/keystore.jks -alias your-key-alias
Make sure to replace path to your keystore.jks and your-key-alias with your actual keystore path and alias.
Note: If you're using deep links, make sure to add the SHA-256 certificate fingerprint from the Play Store (found in Play Console > Setup > App Integrity) to your Firebase project. This is required to verify your app for release and production builds, ensuring proper link handling on Android.
If you want to set up a custom URI scheme for your AppLink, you can enter it in the URI Scheme section. This option is available for both Android and iOS configurations.
Once you've finished configuring everything, click the Done button. You’ll then see the interface shown below, and you can now use this URL configuration to create your AppLinks.
Verifying Your URL Prefix Setup
Once your URL Prefix is configured, you can verify the domain status for deep linking by checking the following URLs:
Android
https://your-domain/.well-known/assetlinks.json
iOS
https://your-domain/.well-known/apple-app-site-association
If the setup is successful, you’ll see your app details listed in the respective files at these URLs.
Create AppLink
Once your URL Prefix configuration is complete, click Create New Link to start creating your AppLink. You can then use it for deep linking and other related services.
Enter the URL suffix, which will appear at the end of your AppLink, then click the Next button to continue.
Enter the AppLink name and the Deep Link URL, then click the Next button to continue.
The Deep Link URL will open in the browser on desktop devices. On mobile devices, it will open in the browser if you’ve chosen that option even if the app is installed.
Configure the link behavior of your iOS app
Select Open Deep Link in Browser if you want the AppLink to open in a web browser. In this case, it will use the default fallback URL you provided during the URL configuration setup.
Select Open Deep Link in Apple App if you want the AppLink to open directly in your iOS app.
If the app is installed, the link will open in the app. If the app is not installed, the user will be redirected to the App Store. If you prefer to redirect users to a different page instead of the App Store, enter a URL in the Custom URL field. This URL will be used when the app is not installed.
Configure the link behavior of your Android app
Select Open Deep Link in Browser if you want the AppLink to open in a web browser. In this case, it will use the default fallback URL you provided during the URL configuration just like it works for iOS.
Select Open Deep Link in Android app if you want the AppLink to open directly in your Android app.
If the app is installed, the link will open in the app. If the app is not installed, the user will be redirected to the Google Play Store. If you prefer to redirect users to a different page instead of the Play Store, enter a URL in the Custom URL field. This URL will be used when the app is not installed.
In the final step, enter the meta details for your link. If you want to display a preview (with an image) when the link is shared, simply fill in the Title, Image URL, and Description fields. Then, click the Create button to generate your AppLink and start sharing it with others.
Analytics Dashboard
You can track your AppLink links performance using analytics dashboard for more details visit analytics page