Notifications Simplepush

Aperçu

• Source: https://simplepu.sh/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 7000
• Format(s) de message pris en charge:
  • ✓MARKDOWN
• Créer votre URL Apprise

Configuration du compte

Simplepush envoie des tâches et des notifications sur votre téléphone. Chaque message envoyé par Apprise arrive sous forme de tâche dans l’application Simplepush et y reste après la notification.

1. Installez l’application Simplepush et ouvrez ses paramètres. Votre API Token y est indiqué.

2. Pour envoyer vers un sujet, créez le sujet dans l’application et demandez aux destinataires de le rejoindre.

3. Pour envoyer au nom d’une organisation, un administrateur de l’organisation crée un jeton d’intégration :

   sp integration create --scopes send

   Le jeton a la forme spi_<credential>.<seed>. Utilisez-le à la place de l’API Token.

Attention

Les URL écrites pour l’ancien service Simplepush (spush://{apikey}, spush://{salt}:{password}@{apikey} et l’option event=) ne fonctionnent plus. Récupérez un nouvel API Token dans l’application Simplepush actuelle et mettez vos URL à jour.

Chiffrement de bout en bout

Les messages, les liens et les pièces jointes peuvent être chiffrés de bout en bout avec XChaCha20-Poly1305, le même procédé que celui des applications Simplepush :

• Envoi vers un sujet avec un mot de passe : chiffré avec le mot de passe de ce sujet.
• Envoi vers vos propres appareils avec un mot de passe : chiffré avec votre mot de passe personnel (Personal Password).
• Envoi d’organisation : chiffré avec la clé de l’organisation dès que celle-ci a activé le chiffrement. Les envois d’organisation n’acceptent pas de mot de passe.

Note

Le chiffrement nécessite le paquet Python PyNaCl :

pip install PyNaCl

Sans lui, Apprise refuse de charger une URL contenant un mot de passe, et un envoi d’organisation dont le chiffrement est activé échoue. Apprise n’envoie jamais votre message en clair à la place. Les envois sans chiffrement n’ont pas besoin de PyNaCl.

Syntaxe

La syntaxe valide est la suivante :

• spush://{api_token}
• spush://{api_token}/{topic}
• spush://{api_token}/{topic1}/{topic2}/{topicN}
• spush://{password}@{api_token}
• spush://{password}@{api_token}/{topic}
• spush://{integration_token}/{topic}
• spush://{integration_token}/@{member}
• spush://{integration_token}/{topic}/@{member1}/@{member2}
• spush://{integration_token}/?broadcast=yes

simplepush:// peut remplacer spush:// dans chacune de ces formes.

Détail des Paramètres

Variable	Obligatoire	Description
api_token	Oui	Votre API Token indiqué dans les paramètres de l’application, ou un jeton d’intégration d’organisation (spi_...).
password	Non	Chiffre le message. Avec un sujet, il s’agit du mot de passe du sujet, sinon de votre mot de passe personnel. Non autorisé avec un jeton d’intégration.
topic	Non	Un ou plusieurs sujets. Chaque sujet reçoit sa propre tâche.
@member	Non	Un membre de l’organisation, précédé de @. Nécessite un jeton d’intégration.
to	Non	Sujets et @membres sous forme de liste séparée par des virgules. Une alternative à leur placement dans le chemin de l’URL.
broadcast	Non	Mettez yes pour envoyer à tous les membres de l’organisation. Nécessite un jeton d’intégration et ne peut pas être combiné avec des sujets ou des membres.
shared	Non	Mettez yes pour envoyer une seule tâche visible par tous les destinataires, la première réponse la résolvant. Par défaut, chaque destinataire reçoit sa propre copie.
priority	Non	De 1 (silencieux) à 5 (critique, sonne même sur un téléphone en mode silencieux). Les noms minimal, low, default, high et critical fonctionnent aussi. La valeur par défaut est 3.
critical_volume	Non	Le volume du son d’alerte critique sur iOS, supérieur à 0 et au plus 1. Nécessite priority=5.
sptag	Non	L’étiquette Simplepush affichée sur la tâche.
links	Non	Liens à joindre à la tâche, séparés par des espaces. 25 au maximum.
topic_auth_token	Non	Le jeton d’authentification d’un sujet protégé.

Paramètres Globaux

Variable	Description
overflow	Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream. 👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite. 👉 truncate : conserve la partie qui tient dans la limite et supprime le reste. 👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre. Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact.
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.
redirect	Par 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.
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.
retry	Nombre 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.
wait	Nombre 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.
optional	Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. Le résultat global de notify() est quand même considéré comme réussi 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.

Exemples

Envoyer une tâche vers vos propres appareils :

# Supposons que :
#  - notre {api_token} soit abcdefghijklmn
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   spush://abcdefghijklmn

Envoyer vers un sujet, chiffré avec le mot de passe du sujet :

# Supposons que :
#  - notre {api_token} soit abcdefghijklmn
#  - notre {topic} soit deploys
#  - le mot de passe du sujet soit s3cret
apprise -vv -t "Déploiement terminé" -b "La version 2.4 est en ligne" \
   "spush://s3cret@abcdefghijklmn/deploys"

Envoyer une alerte critique avec une pièce jointe :

apprise -vv -t "Base de données en panne" -b "Le serveur principal est injoignable" \
   --attach /var/log/postgres.log \
   "spush://abcdefghijklmn/oncall?priority=5&critical_volume=0.5"

Envoyer à deux membres de l’organisation :

# Supposons que :
#  - notre {integration_token} soit spi_cred.seed
apprise -vv -t "Visite du site" -b "Merci de vérifier le portail nord" \
   "spush://spi_cred.seed/@Alice/@Bob"