Notifications Vapid/WebPush

Aperçu

• Source: https://datatracker.ietf.org/doc/html/draft-thomson-webpush-vapi/
• Prise en charge des images: Oui
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 4000
• Créer votre URL Apprise

Configuration du Compte

Vapid/WebPush nécessite un fichier subscriptions.json qui identifie tous les utilisateurs à notifier, ainsi qu’un fichier private_key.pem.

Syntaxe

La syntaxe valide est la suivante :

• vapid://subscription_id/
• vapid://subscription_id/target
• vapid://subscription_id/target1/target2/targetN/

Détail des Paramètres

Variable	Requis	Description
keyfile	Oui	Une clé privée au format PEM appartenant au compte associé au subscription_id.
subfile	Oui	Un fichier subscriptions.json identifiant la configuration à utiliser.
mode	Non	Le mode à utiliser (par défaut chrome). Les valeurs possibles sont chrome, firefox, edge et opera. Ce paramètre simplifie uniquement la source amont utilisée lors de l’envoi de la notification.

Tableau des modes : De nombreuses duplications existent (plusieurs modes pointant vers le même emplacement). L’idée est que si les points de terminaison changent, la mise à jour sera effectuée dans Apprise afin que votre code/URL n’ait pas à changer ultérieurement.

Mode	URL
chrome	https://fcm.googleapis.com/fcm/send
forefpx	https://updates.push.services.mozilla.com/wpush/v1
edge	https://fcm.googleapis.com/fcm/send
opera	https://fcm.googleapis.com/fcm/send
apple	https://web.push.apple.com'
brave	https://fcm.googleapis.com/fcm/send
samsung	https://fcm.googleapis.com/fcm/send
generic	https://fcm.googleapis.com/fcm/send

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.

Configuration du Fichier subscriptions.json

Pour utiliser Vapid, vous devez disposer d’un fichier subscriptions.json vers lequel pointer. Le plugin Vapid prend en charge les 2 formats suivants :

1. Autonome ; dans l’exemple ci-dessous, la cible serait abc123

   {
     "endpoint": "https://fcm.googleapis.com/fcm/send/abc123",
     "keys": {
       "p256dh": "BNcW4oA7zq5H9TKIrA3XfKclN2fX9P_7NR...",
       "auth": "k9Xzm43nBGo="
     }
   }

2. Prise en charge de plusieurs cibles ; dans l’exemple ci-dessous, 2 cibles sont créées, appelées name1 et name2

   {
       "name1": {
           "endpoint": "https://fcm.googleapis.com/fcm/send/...",
           "keys": {
               "p256dh": "BNcW4oA7zq5H9TKIrA3XfKclN2fX9P_7NR...",
               "auth": "k9Xzm43nBGo=",
           }
       },
       "name2": {
           "endpoint": "https://fcm.googleapis.com/fcm/send/...",
           "keys": {
               "p256dh": "BNcW4oA7zq5H9TKIrA3XfKclN2fX9P_7NR...",
               "auth": "k9Xzm43nBGo=",
           }
       }

C’est par le biais des cibles que vous notifiez un ou plusieurs points de terminaison. Si vous utilisez le stockage persistant avec Apprise, vous pouvez simplement gérer votre fichier subscription.json à cet emplacement et votre URL reste épurée. Vous pouvez également spécifier ?subfile= dans votre URL et pointer vers un fichier d’abonnements à charger. L’emplacement peut être local au système de fichiers ou distant (par exemple subfile=https://user:pass@myhost/special/location/subscription.json).

Si aucune cible n’est spécifiée dans votre URL, une cible correspondant à votre propre subscriberid est recherchée dans le fichier subcriptions.json.

Configuration de la Clé Privée (PEM)

De manière similaire au fichier subscription.json, vous devez pointer vers un fichier private_key.pem. Si vous utilisez le stockage persistant d’Apprise, vous pouvez placer le fichier ici. Vous pouvez également spécifier ?keyfile= dans l’URL et pointer vers un fichier local ou distant à utiliser.

Conseils sur le Stockage Persistant

La commande suivante liste tous les emplacements de stockage persistant associés à votre configuration :

apprise storage list

Repérez simplement l’identifiant associé au compte Vapid que vous souhaitez mettre à jour ; les identifiants de répertoire se trouvent aux emplacements suivants :

1. Microsoft Windows : %APPDATA%/Apprise/cache
2. Linux : ~/.local/share/apprise/cache

Pour plus de détails à ce sujet, consultez cette page.

Construction de l’URL Apprise

Ce plugin est plus complexe à utiliser car il nécessite une clé privée PEM binaire ainsi qu’un fichier subscription.json. Il est conseillé d’utiliser un fichier de configuration YAML Apprise structuré comme suit :

urls:
  - vapid://:
      mode: apple
      keyfile: /path/to/keyfile
      subfile: /path/to/subscription.json

N’oubliez pas que keyfile et subfile peuvent également être des URLs, y compris protégées par identifiant/mot de passe :

urls:
  - vapid://:
      mode: apple
      keyfile: https://user:pass123@example.com/private_key.pem
      subfile: https://user:pass123@example.com/subscriptions.json

Si vous ne définissez pas de keyfile et/ou de subfile, les règles décrites ci-dessus s’appliquent et les fichiers par défaut sont recherchés dans votre répertoire de stockage persistant.