Complete Guide to Apple App Site Association JSON Format (2024)

What is the Apple App Site Association (AASA) JSON Format?

The apple-app-site-association (AASA) file is a crucial component for implementing Universal Links in iOS applications. This guide provides a comprehensive breakdown of the AASA JSON structure, helping you implement it correctly for your iOS app.

Essential Components of AASA JSON

1. Basic Structure

Here's the fundamental AASA JSON structure that every implementation must follow:

{
  "applinks": {
    "apps": [],
    "details": [
      {
        "appID": "TEAM_ID.BUNDLE_ID",
        "paths": ["*"]
      }
    ]
  }
}

2. Required Fields Explained

• applinks: The root object that contains all Universal Links configurations
• apps: Must be an empty array (required by Apple)
• details: Array containing your app configurations
• appID: Combination of your Team ID and Bundle ID
• paths: Array of supported URL paths

3. Advanced Configuration Options

For more granular control, you can use the advanced configuration format:

{
  "applinks": {
    "details": [{
      "appID": "TEAM_ID.BUNDLE_ID",
      "paths": ["*"],
      "components": [{
        "/": "/articles/*",
        "comment": "Matches all article pages"
      }]
    }]
  }
}

4. Common Implementation Mistakes

Use our Universal Link Validator to automatically check your JSON format.

5. iOS Version Compatibility

Simplified Setup Process