Aller au contenu

Notifications Pushover

Aperçu

La configuration des notifications Pushover est assez simple. Le message est essentiellement transmis a votre compte Pushover en ligne, puis redirige vers les appareils que vous y avez configures.

Une fois connecte au site web, votre tableau de bord affichera votre {user_key}.

Sur le tableau de bord, apres connexion, faites defiler vers le bas pour trouver l’option permettant de generer une application. Une fois cette operation effectuee, un jeton API associe a cette application vous sera fourni. Il deviendra votre {token}.

La syntaxe valide est la suivante :

  • pover://{user_key}@{token}
  • pover://{user_key}@{token}/{device_id}
  • pover://{user_key}@{token}/{device_id1}/{device_id2}/{device_idN}
  • pover://{user_key}@{token}/#{group_key}
  • pover://{user_key}@{token}/{device_id}/#{group_key}
  • pover://{user_key}@{token}?priority={priority}
  • pover://{user_key}@{token}?priority=emergency&expire={expire}&interval={interval}
  • pover://{user_key}@{token}?key={cle_chiffrement}
  • pover://{user_key}@{token}?key={cle_chiffrement}&e2ee=no
VariableObligatoireDescription
user_keyOuiIdentifiant de cle utilisateur associe a votre compte Pushover. Ce n’est pas votre adresse e-mail. Cette cle peut etre recuperee depuis votre tableau de bord Pushover.
tokenOuiJeton associe a votre compte Pushover.
device_idNonIdentifiant de l’appareil auquel envoyer la notification. Si aucune valeur n’est precisee, tous les appareils associes a votre compte seront notifies.
group_keyNonCle d’un groupe de diffusion Pushover, prefixee par #. Les group_key ressemblent aux user_key et permettent de diffuser un message a tous les membres d’un groupe avec une seule cle. Plusieurs groupes peuvent etre specifies. Les groupes et les appareils peuvent etre melanges dans une meme URL.
priorityNonPeut etre low, moderate, normal, high ou emergency ; la valeur par defaut est normal si aucune priorite n’est precisee.
Pour envoyer une notification en priorite d’urgence, les parametres interval et expire devraient etre fournis. Vous pouvez aussi utiliser les priorites telles que documentees dans l’API Pushover, ou -2 est low, -1 est moderate, 0 est normal, 1 est high et 2 est emergency.
expireNonLe parametre expire precise pendant combien de secondes votre notification continuera a etre retentee, toutes les interval secondes. Si la notification n’a pas ete acquittee avant expire secondes, elle sera marquee comme expiree et ne sera plus envoyee. Notez qu’elle reste visible pour l’utilisateur apres expiration, mais ne lui demandera plus d’acquittement. Cette valeur ne peut pas depasser 10800 secondes, soit 3 heures. La valeur par defaut est 3600 secondes, soit 1 heure, si rien n’est precise.
intervalNonPrecise a quelle frequence, en secondes, les serveurs Pushover renverront la meme notification d’urgence a l’utilisateur. Si l’utilisateur se trouve dans un environnement bruyant ou dort, retenter la notification, avec son et vibration, peut aider a attirer son attention. Cette valeur doit etre d’au moins 30 secondes entre deux tentatives. La valeur par defaut est 900 secondes, soit 15 minutes, si rien n’est precise. Note : ce parametre est distinct du mecanisme retry d’Apprise, qui controle le nombre de tentatives d’envoi en cas d’echec.
soundNonPermet de preciser l’un des effets sonores facultatifs identifies ici. Le son par defaut est pushover.
urlNonPermet de fournir une URL supplementaire accompagnee de votre message.
url_titleNonPermet de fournir un titre pour l’URL supplementaire accompagnee de votre message.
keyNonChaine hexadecimale de 64 caracteres representant une cle AES 256 bits utilisee pour le chiffrement de bout en bout. Lorsqu’elle est definie, les champs message, title, url et url_title sont chiffres cote client avant d’etre transmis a l’API Pushover. Necessite le paquet Python cryptography (pip install cryptography). Si le paquet est absent, Apprise envoie le message en texte clair avec un avertissement.
e2eeNonControle si le chiffrement de bout en bout est applique lorsqu’une key est configuree. La valeur par defaut est yes. Definir sur no pour envoyer temporairement en texte clair meme lorsqu’une cle est presente.
VariableDescription
overflowCe 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.
formatCe 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é.
verifyLes 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.
redirectPar défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle vaut yes.
ctoSignifie 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.
rtoSignifie 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.
emojisActive 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.
tzIdentifie 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.
retryNombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative — une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
waitNombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro — un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optionalLorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. L’appel global notify() retourne quand même True même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives — toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Lorsque le chiffrement E2EE est active, le contenu du message est chiffre du cote d’Apprise avant d’etre envoye — les serveurs Pushover ne voient jamais le texte en clair. Seuls les appareils configures avec la meme cle peuvent dechiffrer et afficher les notifications.

Vous creez vous-meme la cle de chiffrement. Il s’agit d’une valeur aleatoire de 256 bits representee sous forme d’une chaine de 64 caracteres hexadecimaux. Executez l’une des commandes ci-dessous pour en generer une :

Fenêtre de terminal
python3 -c "import secrets; print(secrets.token_hex(32))"

Copiez la chaine de 64 caracteres affichee. Cette chaine est votre cle de chiffrement. Conservez-la en lieu sur — vous en aurez besoin a l’etape suivante et chaque fois que vous configurerez un nouvel appareil.

Etape 2 — Configurer la Cle sur Chaque Appareil Pushover

Section intitulée « Etape 2 — Configurer la Cle sur Chaque Appareil Pushover »

Chaque appareil iOS ou Android devant afficher les notifications dechiffrees doit etre configure avec la meme cle. Ouvrez l’application Pushover, acceez a ses Parametres, et recherchez une option Chiffrement ou Chiffrement de bout en bout. Collez votre cle hexadecimale de 64 caracteres dans le champ et enregistrez.

Repetez cette operation sur chaque telephone ou tablette ou vous recevez des notifications Pushover. Tout appareil sans la cle configuree affichera la notification comme du texte chiffre illisible.

Ajoutez ?key= suivi de votre chaine hexadecimale de 64 caracteres a l’URL Pushover :

pover://{user_key}@{token}?key={votre-cle-hexadecimale-64-chars}

Consultez la section Exemples ci-dessous pour une commande complete.

Le chiffrement E2EE requiert le paquet Python cryptography. Installez-le avec :

Fenêtre de terminal
pip install cryptography

Si le paquet n’est pas installe et qu’une key est configuree, Apprise enregistre un avertissement et envoie le message sans chiffrement en repli gracieux. Definissez e2ee=no pour envoyer intentionnellement en texte clair tout en conservant la cle dans l’URL pour une utilisation future.

L’integration Pushover limite normalement les sons de notification a une liste predefinie. Cette prise en charge ajoute la possibilite d’utiliser un son personnalise dans les notifications, a condition qu’il ait ete televerse et nomme. L’integration Pushover a donc ete mise a jour pour permettre de specifier ce nom au lieu de declencher une erreur.

  1. Allez dans Settings -> Alert Settings -> Manage custom sounds -> Upload a sound
  2. Televersez un son et donnez-lui un nom, par exemple “mysound”.
  3. Verifiez que le son est accessible et apparait dans la liste des sons de votre application via https://api.pushover.net/1/sounds.json?token={app-token}
  4. Precisez ensuite ce son dans votre appel pover, par exemple apprise -vv -t "title" -b "test message" pover://user@app?sound=mysound

Vous devriez entendre votre son personnalise sur la notification. Si le nom du son personnalise n’est pas trouve, le son de notification Pushover par defaut sera joue.

Envoyer une notification Pushover a tous nos appareils configures :

Fenêtre de terminal
# Supposons que notre {user_key} soit 435jdj3k78435jdj3k78435jdj3k78
# Supposons que notre {token} soit abcdefghijklmnop-abcdefg
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
pover://435jdj3k78435jdj3k78435jdj3k78@abcdefghijklmnop-abcdefg

Envoyer une notification Pushover a un groupe de diffusion :

Fenêtre de terminal
# Supposons que notre {user_key} soit 435jdj3k78435jdj3k78435jdj3k78
# Supposons que notre {token} soit abcdefghijklmnop-abcdefg
# Supposons que notre {group_key} soit gznej3rKEVAvPUxu9vvNnqpmZpokzF
# Le prefixe # l'identifie comme une group key
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
"pover://435jdj3k78435jdj3k78435jdj3k78@abcdefghijklmnop-abcdefg/#gznej3rKEVAvPUxu9vvNnqpmZpokzF"

Envoyer une notification Pushover avec la priorite Emergency :

Fenêtre de terminal
# La priorite Emergency recommande aussi de preciser les valeurs
# expire et interval (intervalle de relance d'urgence).
# Supposons que notre {user_key} soit 435jdj3k78435jdj3k78435jdj3k78
# Supposons que notre {token} soit abcdefghijklmnop-abcdefg
# L'exemple ci-dessous definit une expiration de 1 heure et tente
# de renvoyer le message toutes les 10 minutes :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
pover://435jdj3k78435jdj3k78435jdj3k78@abcdefghijklmnop-abcdefg?priority=emergency&interval=600&expire=3600

Envoyer une notification Pushover chiffree de bout en bout :

Fenêtre de terminal
# Supposons que notre {user_key} soit 435jdj3k78435jdj3k78435jdj3k78
# Supposons que notre {token} soit abcdefghijklmnop-abcdefg
# Supposons que notre cle de chiffrement hexadecimale de 64 chars soit aabbcc...
# (generez-en une avec les commandes de la section ci-dessus)
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
"pover://435jdj3k78435jdj3k78435jdj3k78@abcdefghijklmnop-abcdefg?key=aabbccdd11223344aabbccdd11223344aabbccdd11223344aabbccdd11223344"
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ?

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada