Activer les applications pour les sites web à l’aide de gestionnaires d’URI d’application

Article
06/02/2023

Apps for Websites associe votre application à un site web afin que lorsqu’une personne ouvre un lien vers votre site web, votre application soit lancée au lieu d’ouvrir le navigateur. Si votre application n’est pas installée, votre site web s’ouvre dans le navigateur comme d’habitude. Cette expérience est très fiable puisque seuls les propriétaires de contenus vérifiés peuvent s’inscrire pour créer ce type de lien. Les utilisateurs pourront case activée tous leurs liens web-à-application inscrits en accédant à Paramètres > Applications > Applications pour les sites web.

Pour activer la liaison web-à-application, vous devez :

identifier les URI gérés par votre application dans le fichier manifeste ;
Fichier JSON qui définit l’association entre votre application et votre site web. avec le nom de famille du package d’application à la même racine hôte que la déclaration du manifeste d’application.
gérer l’activation dans l’application.

Notes

À compter de la mise à jour Windows 10 Creators, les liens pris en charge cliqués dans Version antérieure de Microsoft Edge lancent l’application correspondante. Les liens pris en charge cliqués dans d’autres navigateurs (par exemple, Microsoft Edge Chromium, Internet Explorer, etc.) vous permettent de rester dans l’expérience de navigation.

S’inscrire pour bénéficier du traitement des liens http et https dans le manifeste de l’application

Votre application a besoin d’identifier les URI pour les sites web qu’elle gère. Pour ce faire, ajoutez l’inscription d’extension Windows.appUriHandler au fichier manifeste de votre application Package.appxmanifest.

Par exemple, si l’adresse de votre site web est « msn.com », vous devez saisir le code suivant dans le fichier manifeste de votre application :

<Applications>
  <Application ... >
      ...
      <Extensions>
         <uap3:Extension Category="windows.appUriHandler">
          <uap3:AppUriHandler>
            <uap3:Host Name="msn.com" />
          </uap3:AppUriHandler>
        </uap3:Extension>
      </Extensions>
  </Application>
</Applications>

La déclaration ci-dessus inscrit votre application afin qu’elle puisse gérer des liens à partir de l’hôte spécifié. Si votre site web comporte plusieurs adresses (par exemple : m.example.com www.example.com et example.com), ajoutez une autre entrée <uap3:Host Name=... /> dans <uap3:AppUriHandler> pour chaque adresse.

Associer votre application et votre site web à un fichier JSON

Pour faire en sorte que seule votre application puisse ouvrir du contenu sur votre site web, ajoutez le nom de la famille de packages de votre application dans un fichier JSON situé à la racine du serveur web ou dans le répertoire connu du domaine. Cela signifie que votre site web autorise les applications répertoriées à ouvrir du contenu sur votre site. Vous pouvez trouver le nom de la famille de packages dans la section Packages du concepteur de manifestes de l’application.

Important

Le fichier JSON ne doit pas contenir le suffixe de fichier .json.

Créez un fichier JSON (sans l’extension de fichier .json) nommé windows-app-web-link et indiquez le nom de la famille de packages de votre application. Par exemple :

[{
  "packageFamilyName" : "Your app's package family name, e.g MyApp_9jmtgj1pbbz6e",
  "paths" : [ "*" ],
  "excludePaths" : [ "/news/*", "/blog/*" ]
 }]

Windows utilisera une connexion https vers votre site web et recherchera le fichier JSON correspondant sur votre serveur web.

Caractères génériques

L’exemple de fichier JSON ci-dessus illustre l’utilisation des caractères génériques. Les caractères génériques vous permettent de prendre en charge une grande diversité de liens, avec moins de lignes de code. La liaison application-site web prend en charge deux types de caractères génériques dans le fichier JSON :

Caractère générique	Description
*	Représente une sous-chaîne
?	Représente un caractère unique

Par exemple, dans "excludePaths" : [ "/news/*", "/blog/*" ] l’exemple ci-dessus, votre application prend en charge tous les chemins qui commencent par l’adresse de votre site web (par exemple, msn.com), à l’exception de ceux sous /news/ et /blog/. msn.com/weather.html sera pris en charge, mais pas msn.com/news/topnews.html.

Applications multiples

Si vous avez deux applications que vous voulez lier à votre site web, répertoriez les noms de famille de packages des deux applications dans votre fichier JSON windows-app-web-link. Les deux applications peuvent être prises en charge. L’utilisateur pourra alors choisir le lien par défaut si les deux sont installées. S’ils souhaitent modifier le lien par défaut ultérieurement, ils peuvent le modifier dans Paramètres > Applications pour les sites web. Les développeurs peuvent également modifier le fichier JSON à tout moment et voir leur modification le jour même, mais pas plus de huit jours après la mise à jour.

[{
  "packageFamilyName": "Your apps's package family name, e.g MyApp_9jmtgj1pbbz6e",
  "paths": [ "*" ],
  "excludePaths" : [ "/news/*", "/blog/*" ]
 },
 {
  "packageFamilyName": "Your second app's package family name, for example, MyApp2_8jmtgj2pbbz6e",
  "paths": [ "/example/*", "/links/*" ]
 }]

Pour offrir à vos utilisateurs la meilleure expérience possible, utilisez les chemins d’accès des exclusions pour vous assurer que le contenu uniquement en ligne est exclu des chemins d’accès pris en charge dans votre fichier JSON.

Les chemins d’accès des exclusions sont vérifiés en premier lieu et, s’il existe une correspondance, la page correspondante s’ouvre avec le navigateur au lieu de l’application désignée. Dans l’exemple ci-dessus, « /news/* » inclut toutes les pages sous ce chemin, tandis que « /news* » (aucune barre oblique oblique 'news') inclut tous les chemins sous 'news*', tels que 'newslocal/', 'newsinternational/', et ainsi de suite.

Gérer les liens à l’activation pour créer un lien vers le contenu

Accédez au fichier App.xaml.cs dans la solution Visual Studio de votre application puis, dans OnActivated(), ajoutez la gestion des contenus liés. Dans l’exemple suivant, la page ouverte ouvert dans l’application dépend du chemin d’accès de l’URI :

protected override void OnActivated(IActivatedEventArgs e)
{
    Frame rootFrame = Window.Current.Content as Frame;
    if (rootFrame == null)
    {
        ...
    }

    // Check ActivationKind, Parse URI, and Navigate user to content
    Type deepLinkPageType = typeof(MainPage);
    if (e.Kind == ActivationKind.Protocol)
    {
        var protocolArgs = (ProtocolActivatedEventArgs)e;        
        switch (protocolArgs.Uri.AbsolutePath)
        {
            case "/":
                break;
            case "/index.html":
                break;
            case "/sports.html":
                deepLinkPageType = typeof(SportsPage);
                break;
            case "/technology.html":
                deepLinkPageType = typeof(TechnologyPage);
                break;
            case "/business.html":
                deepLinkPageType = typeof(BusinessPage);
                break;
            case "/science.html":
                deepLinkPageType = typeof(SciencePage);
                break;
        }
    }

    if (rootFrame.Content == null)
    {
        // Default navigation
        rootFrame.Navigate(deepLinkPageType, e);
    }

    // Ensure the current window is active
    Window.Current.Activate();
}

Important Veillez à remplacer la dernière logique if (rootFrame.Content == null) par rootFrame.Navigate(deepLinkPageType, e);, comme indiqué dans l’exemple ci-dessus.

Test : outil de validation locale

Vous pouvez tester la configuration de votre application et de votre site web en exécutant l’outil de vérification de l’inscription de l’hôte de l’application disponible dans :

%windir%\system32\AppHostRegistrationVerifier.exe

Testez la configuration de votre application et de votre site web en exécutant cet outil avec les paramètres suivants :

AppHostRegistrationVerifier.exehostname packagefamilyname filepath

Nom d’hôte : votre site web (par exemple, microsoft.com)
Package Family Name : le nom de la famille de packages (PFN) de votre application
Chemin du fichier : fichier JSON pour la validation locale (par exemple, C:\SomeFolder\windows-app-web-link)

Si l’outil ne retourne rien, la validation fonctionne sur ce fichier lors du chargement. S’il existe un code d’erreur, il ne fonctionnera pas.

Vous pouvez activer la clé de Registre suivante pour forcer la correspondance de chemin pour les applications chargées de côté dans le cadre de la validation locale :

HKCU\Software\Classes\LocalSettings\Software\Microsoft\Windows\CurrentVersion\ AppModel\SystemAppData\YourApp\AppUriHandlers

Nom de clé : ForceValidation Valeur : 1

Test : validation sur le web

Fermez votre application pour vérifier que l’application est activée lorsque vous cliquez sur un lien. Copiez ensuite l’adresse de l’un des chemins d’accès pris en charge dans votre site web. Par exemple, si l’adresse de votre site web est « msn.com » et que l’un des chemins de support est « path1 », vous utilisez http://msn.com/path1

Vérifiez que votre application est fermée. Appuyez sur la touche Windows + R pour ouvrir la boîte de dialogue Exécuter, puis collez le lien dans la fenêtre. Votre application doit alors démarrer à la place du navigateur web.

Vous pouvez aussi tester votre application en la démarrant à partir d’une autre application à l’aide de l’API LaunchUriAsync. Vous pouvez utiliser cette API pour tester également votre application sur des téléphones.

Si vous souhaitez suivre la logique d’activation du protocole, définissez un point d’arrêt dans le gestionnaire d’événements OnActivated.

Conseils concernant AppUriHandlers :

Veillez à spécifier uniquement les liens que votre application peut gérer.
Répertoriez tous les hôtes que vous allez prendre en charge. Notez que www.example.com et example.com sont des hôtes différents.
Les utilisateurs peuvent utiliser le menu Paramètres pour choisir l’application qu’ils préfèrent pour la gestion des sites web.
Votre fichier JSON doit être téléchargé sur un serveur https.
Si vous devez modifier les chemins d’accès que vous souhaitez prendre en charge, vous pouvez republier votre fichier JSON sans avoir à republier votre application. Les utilisateurs verront ces modifications dans un délai de 1 à 8 jours.
Toutes les applications chargées de manière indépendante avec AppUriHandlers auront des liens validés pour l’hôte au moment de l’installation. Il est inutile de charger un fichier JSON pour tester la fonctionnalité.
Cette fonctionnalité fonctionne chaque fois que votre application est une application UWP lancée avec LaunchUriAsync ou une application de bureau Windows lancée avec ShellExecuteEx. Si l’URL correspond à un gestionnaire d’URI d’application enregistré, l’application sera lancée en lieu et place du navigateur.

Voir aussi

Exemple de projet web à application windows.protocol registration Handle URI Activation Association Exemple de lancement de l’API LaunchUriAsync().