Deep Dive into apple-app-site-association file: Enhancing Deep Linking on iOS

Denner Parreiras — Wed, 21 Feb 2024 14:58:44 +0000

In the previous article, "Understanding Digital Asset Links File: A Key to Efficient and Secure Deep Linking", we explored how Digital Asset Links establish a connection between websites and Android apps for deep linking. Now, let's delve deeper into Apple's equivalent --- the apple-app-site-association file - and how it significantly enhances deep linking experience on iOS devices.

The Inception of `apple-app-site-association`

Introduced in iOS 9, Universal Links brought a paradigm shift in handling deep links in iOS. This feature allows URLs to open directly in a corresponding native app, bypassing the Safari browser, providing a seamless user experience. The backbone of Universal Links is the apple-app-site-association file, which is fundamental in verifying that a link should be opened in an app instead of Safari.

Crafting the `apple-app-site-association` File: A Step-by-Step Guide

1. Creating the File

The apple-app-site-association is a JSON file that needs no signature, unlike its predecessor. This file should be created at the root of your HTTPS web server, ideally placed in the /.well-known/ directory.

2. Structuring the File

A typical apple-app-site-association file looks like this:

{
  "applinks": {
    "apps": [],
    "details": [
      {
        "appID": "9JA89QQLNQ.com.example.app",
        "paths": [ "/path/to/content", "/path/*", "NOT /path/to/exclude" ]
      }
    ]
  }
}

appID: Your team ID from Apple Developer account combined with your app's bundle ID.
paths: Specifies which paths in your website should open the app. It supports simple wildcards and exclusions.

3. Hosting Requirements

Ensure your server supports HTTPS. The apple-app-site-association file must be accessible via an HTTPS URL and must not redirect to another location.

4. Updating Your iOS App

In your Xcode project, enable Associated Domains and add the domain links you wish to associate with your app, prefixed with applinks:.

How Does This Enhance Deep Linking on iOS?

The apple-app-site-association file plays a critical role in:

Security: By confirming that the domain and app association is verified, it prevents unauthorized apps from intercepting your URLs.
User Experience: Universal Links provide a more integrated experience. Users are taken directly to the content in the app, rather than Safari, enhancing usability.
Consistency: Universal Links work uniformly across all iOS devices, ensuring a consistent behavior.

Conclusion

The implementation of apple-app-site-association for Universal Links in iOS is a significant step towards a more integrated mobile experience. It streamlines the process of opening web content directly in apps, enhancing both security and user experience. As we continue to see evolution in mobile app technologies, tools like these will become increasingly important in bridging the gap between web and mobile applications.

Understanding Digital Asset Links File: A Key to Efficient and Secure Deep Linking

Denner Parreiras — Wed, 21 Feb 2024 14:56:13 +0000

What is a Digital Asset Links File?

The Digital Asset Links file is an essential tool in the app development world for both Android and iOS, particularly when it comes to implementing deep linking effectively and securely. This JSON file establishes a trust relationship between your website and your app, ensuring that links opened on mobile devices directly lead to the corresponding app, if installed.

How Does It Work?

The operation of Digital Asset Links involves a few key steps:

Hosting the File: The file must be hosted on the domain of the site, typically at the path /.well-known/assetlinks.json. This allows the mobile device's operating systems to verify whether a particular app is authorized to open links from a specific domain.
Automatic Verification: When a link is clicked, the device's operating system checks if there is an installed app with the domain verified in the Digital Asset Links file. If confirmed, the link opens directly in the app; otherwise, it will open in the default browser.

File Structure

A typical example of the Digital Asset Links file is:

[
  {
    "relation": ["delegate_permission/common.handle_all_urls"],
    "target": {
      "namespace": "android_app",
      "package_name": "com.example.yourapp",
      "sha256_cert_fingerprints": ["YOUR_SHA_256_CERT_FINGERPRINT"]
    }
  }
]

Each field serves a specific purpose:

relation: Defines the type of relationship between the site and the app. It's usually ["delegate_permission/common.handle_all_urls"] for deep linking.
target: Specifies the target app with details like package_name and sha256_cert_fingerprints for Android.

Android and iOS Versions

For Android, support for App Links was introduced in Android 6.0 (Marshmallow), and it has since become a standard for deep linking implementation.

On iOS, the equivalent concept is known as Universal Links and was introduced in iOS 9. Instead of using a Digital Asset Links file, iOS uses a file called apple-app-site-association.

Solving Deep Linking Problems

The use of the Digital Asset Links file on Android and the apple-app-site-association file on iOS solves several common deep linking issues:

Improved User Experience: Instead of asking the user whether they want to open a link in the app or browser, the link directly opens in the app if it is installed.
Enhanced Security: These files ensure that only authorized apps can open links from a specific domain, preventing potential abuses.
Ease of Implementation: Once set up, the management of deep links becomes much more streamlined and integrated, without the need for additional prompts or choices for the user.

Conclusion

The Digital Asset Links file in Android and its iOS equivalent are fundamental for effective and secure deep linking implementation in modern apps. By ensuring that links correctly direct to the right apps, they not only enhance user experience but also increase the security and reliability of interactions between websites and mobile applications.

DEV Community: Denner Parreiras

Deep Dive into apple-app-site-association file: Enhancing Deep Linking on iOS

The Inception of apple-app-site-association

Crafting the apple-app-site-association File: A Step-by-Step Guide

1. Creating the File

2. Structuring the File

3. Hosting Requirements

4. Updating Your iOS App

How Does This Enhance Deep Linking on iOS?

Conclusion

Understanding Digital Asset Links File: A Key to Efficient and Secure Deep Linking

What is a Digital Asset Links File?

How Does It Work?

File Structure

Android and iOS Versions

Solving Deep Linking Problems

Conclusion

The Inception of `apple-app-site-association`

Crafting the `apple-app-site-association` File: A Step-by-Step Guide