Notifications API Apprise

Aperçu

• Source: https://github.com/caronc/apprise-api
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du Compte

Mettez en place une instance auto-hebergee de Apprise-API et utilisez ce service pour vous y integrer a distance.

Syntaxe

La syntaxe valide est la suivante :

• apprise://{host}/{token}
• apprise://{host}:{port}/{token}
• apprise://{user}@{host}:{port}/{token}
• apprise://{user}:{password}@{host}:{port}/{token}

Pour une connexion securisee, utilisez plutot apprises.

• apprises://{host}/{token}
• apprises://{host}:{port}/{token}
• apprises://{user}@{host}:{port}/{token}
• apprises://{user}:{password}@{host}:{port}/{token}

Détail des Paramètres

Variable	Obligatoire	Description
hostname	Oui	Nom d’hote du serveur web.
port	Non	Port sur lequel votre serveur web ecoute. La valeur par defaut est 80 pour apprise:// et 443 pour toutes les references apprises://.
user	Non	Si votre systeme est configure pour utiliser HTTP-AUTH, vous pouvez fournir le username pour vous authentifier.
password	Non	Si votre systeme est configure pour utiliser HTTP-AUTH, vous pouvez fournir le password pour vous authentifier.
tags	Non	Vous pouvez facultativement definir les tags que vous souhaitez fournir lors de votre appel au serveur API Apprise.

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.

Exemples

Envoyer une notification a un serveur API Apprise a l’ecoute sur le port 80 :

# Supposons que notre {hostname} soit apprise.server.local
# Supposons que notre {token} soit token
apprise -vv --body="Message de Test" \
   "apprise://apprise.server.local/token"

Voici un autre exemple ou vous pouvez appeler votre serveur Apprise selon les tags fournis :

# Supposons que notre {hostname} soit apprise.server.local
# Supposons que notre {token} soit token
# Supposons que nous voulions declencher toute notification associee au {tag} email
apprise -vv --body="Message de Test" \
   "apprise://apprise.server.local/token?tags=email"

Vous pouvez aussi utiliser la logique ET et OU lorsque vous transmettez des tags :

Valeur tags=	Services selectionnes
TagA	Possede TagA
TagA TagB	Possede TagA ET TagB
TagA+TagB	Possede TagA ET TagB
TagA&TagB	Possede TagA ET TagB
TagA,TagB	Possede TagA OU TagB
TagA|TagB	Possede TagA OU TagB
TagA TagC,TagB	Possede (TagA ET TagC) OU TagB

# Exemple OU
apprise -vv --body="Message de Test" \
   "apprise://apprise.server.local/token?tags=devops,finance"

# Exemple ET
apprise -vv --body="Message de Test" \
   "apprise://apprise.server.local/token?tags=devops alerts"

# Exemple mixte : (comment AND create) OR admin
apprise -vv --body="Message de Test" \
   "apprise://apprise.server.local/token?tags=comment create,admin"

Manipulation des en-tetes

Certains utilisateurs peuvent avoir besoin d’en-tetes HTTP speciaux lors de l’envoi de leurs donnees vers leur serveur. Pour cela, il suffit d’ajouter un symbole plus, +, devant n’importe quel parametre precise dans votre URL.

# L'exemple ci-dessous definirait l'en-tete :
#    X-Token: abcdefg
#
# Supposons que notre {hostname} soit localhost
# Supposons que notre {port} soit 8080
# Supposons que notre {token} soit apprise
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "apprise://localhost:8080/apprise/?+X-Token=abcdefg"

# Pour plusieurs en-tetes, il suffit d'ajouter plus d'entrees :
# L'exemple ci-dessous definirait les en-tetes :
#    X-Token: abcdefg
#    X-Apprise: is great
#
# Supposons que notre {hostname} soit localhost
# Supposons que notre {port} soit 8080
# Supposons que notre {token} soit apprise
# Dans cet exemple, nous permettons la definition d'un chemin URL personnalise
# dans le cas ou notre API Apprise serait hebergee a cet endroit
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "apprise://localhost:8080/path/apprise/?+X-Token=abcdefg&+X-Apprise=is%20great"

Remarque : ce service est un peu redondant, car vous pouvez deja utiliser la CLI et pointer sa configuration vers un serveur API Apprise existant, via --config dans la CLI ou la classe AppriseConfig() via son API interne.

# Exemple simple de la CLI Apprise utilisant plutot un fichier de configuration :
# recuperation d'une configuration deja stockee
# Supposons que notre {hostname} soit localhost
# Supposons que notre {port} soit 8080
# Supposons que notre {token} soit apprise
apprise --body="test message" --config=http://localhost:8080/get/apprise