配置 apple-app-site-association 文件并上传到服务器

Question

I am new on iOS development. I am implementing Universal Links in iOS App with ASP.net application.
I have define my associate domain in capabilities under Associated Domains: applinks:www.abcd.com
And also configure in App Ids on Apple Developer Account. I think app side work is all set .

But I think problem with apple-app-site-association file.

I have written json in a simple text file like below

{
  "applinks": {
    "apps": [],
    "details": [
    {
      "appID": "8T8932TY.com.AppName”,
      "paths": ["*"]
    }
    ]
  }
}

Now I am stuck here. My application targeting on iOS 9 and above. I am confused that what is the extension of this file with naming apple-app-site-association. If I need to signed in with new certificates or not. And how upload it on server side.

Please guys help me out. I am searching lot for this but not get satisfactory answer.

Thanks

Answer 1

Your example JSON looks fine if substituted with real values for the AppID/AppName. You may want to be specific about what routes you handle but that's up to you - it's a better user experience to only try to handle routes that there's some chance you'll be able to handle, rather than opening your app for every link on your domain and kicking the user out to Safari again if that turns out not to be true.

The apple-app-site-association file should not have any file extension, and should be served from the root of your site, https://example.com/apple-app-site-association , and/or from https://example.com/.well-known/apple-app-site-association .

You say you're supporting iOS 9 and above - the change to check the .well-known route, which is checked first, came in iOS 9.3, so if you want to support below that OS, you're best off putting the file in both locations. See this answer for details.

It's also important that the file is served with the correct MIME-type, for Universal Links it can be served as application/json , and there's no need to sign/encrypt it. Getting it served with the correct MIME-type can be a little annoying if you're not familiar with configuration on your web server, as typically servers will determine the MIME-type from the file extension. You can't give it an extension, as iOS won't check the url with an extension and (IIRC) redirects are not allowed so you can't fake it by doing that either.

So that's a summary of what you're trying to accomplish, but how you do that depends on the web server you're using. For an ASP app that's likely to be IIS, in which case this question and its answers may help you configure your web server correctly. The details of how you upload a file to the root of that server will very much depend on how you've configured it as well.

Answer 2

There is no extension for this apple-app-site-association file. This is just a plain file. You have to host it on the top level of your domain meaning the file location will be https://www.abcd.com/apple-app-site-association Once you host it you can check/validate by using this link https://branch.io/resources/aasa-validator/

For detailed info please refer: https://blog.branch.io/how-to-setup-universal-links-to-deep-link-on-apple-ios-9/

Answer 3

This worked for me.

1. Created an empty .NET Core project and deployed it to the corresponding Azure web app service.
2. Using, Advanced tools in Azure portal, nvaigated to the Kudu files of the deployed app service.
3. Inside the folder "site/wwwroot/wwwroot" created a new folder named ".well-known".
4. Inside the newly created folder, created a new file named "apple-app-site-association.json".
5. Edited the newly created json file to hold the app details.
6. Modifed the file "site/wwwroot/web.config" for the following reasons:

a) Since iOS always calls the URLs without file extension mentioned ( https://webapp-sftpint-employeeapp-dev.azurewebsites.net/apple-app-site-association ) we need to forcefully reqrite such URLs to have the file extension. Hence, added the rule in web.config

b) Since the response header should have "application/json" for the content returned from the static file "apple-app-site-association.json", we added the explicit mentioning of the mimeType as "application/json".

So, the web.config file looks somewhat like this. (only the 'rewrite' and 'staticContent' blocks needs to be added additionally)

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <location path="." inheritInChildApplications="false">
    <system.webServer>
      <handlers>
        <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" resourceType="Unspecified" />
      </handlers>
      <aspNetCore processPath="dotnet" arguments=".\yourproject.dll" stdoutLogEnabled="false" stdoutLogFile=\\?\%home%\LogFiles\stdout hostingModel="inprocess" />
      <rewrite>
          <rules>`enter code here`
              <rule name="apple_json_file">
                  <match url="^apple-app-site-association" />
                  <action type="Rewrite" url=".well-known/apple-app-site-association.json" />
              </rule>
          </rules>
      </rewrite>
      <staticContent>
          <mimeMap fileExtension=".json" mimeType="application/json" />
      </staticContent>      
    </system.webServer>
  </location>
</configuration>