Notifications Custom XML

Aperçu

• Prise en charge des images: Oui
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Introduction

Il s’agit d’une notification personnalisée qui permet à cet outil de publier vers un serveur Web sous forme d’une simple chaîne XML. Cela est utile pour ceux qui souhaitent être notifiés via leurs propres méthodes personnalisées.

Le format pourrait ressembler à ceci :

<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Corps du Message>
        <Notification xmlns:xsi="http://nzbget.lead2gold.org/notify/NotifyXML-1.0.xsd">
            <Version>1.0</Version>
            <Subject>What A Great Movie Downloaded Successfully</Subject>
            <MessageType>info</MessageType>
            <Message>Plenty of details here...</Message>
       </Notification>
    </soapenv:Corps du Message>
</soapenv:Envelope>

Le champ MessageType sera l’une des valeurs suivantes :

• info : Un message de type informatif
• success : Un rapport de succès
• failure : Un rapport d’échec
• warning : Un rapport d’avertissement

Syntaxe

La syntaxe valide est la suivante :

• xml://{hostname}
• xml://{hostname}:{port}
• xml://{user}:{password}@{hostname}
• xml://{user}:{password}@{hostname}:{port}

L’ajout d’un s au schéma (c’est-à-dire xmls://) bascule vers une connexion HTTPS sécurisée :

• xmls://{hostname}
• xmls://{hostname}:{port}
• xmls://{user}:{password}@{hostname}
• xmls://{user}:{password}@{hostname}:{port}

Détail des Paramètres

Variable	Requis	Description
hostname	Oui	Le nom d’hôte du serveur Web
port	Non	Le port sur lequel notre serveur Web est en écoute. Par défaut, le port est 80 pour xml:// et 443 pour toutes les références xmls://.
user	Non	Si votre système est configuré pour utiliser HTTP-AUTH, vous pouvez fournir le nom d’utilisateur pour l’authentification.
password	Non	Si votre système est configuré pour utiliser HTTP-AUTH, vous pouvez fournir le mot de passe pour l’authentification.
method	Non	Spécifier éventuellement la méthode HTTP du serveur ; les options possibles sont post, put, get, delete, patch, head, update et options. Par défaut, si aucune méthode n’est spécifiée, post est utilisé.

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 XML à notre serveur Web en écoute sur le port 80 :

# Assuming our {hostname} is xml.server.local
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   xml://xml.server.local

Méthode HTTP

Par défaut, toutes les notifications sont envoyées en tant que requête POST. Modifiez ce comportement avec le paramètre URL method :

# Send as a PUT request
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost/?method=put"

# Send as a DELETE request
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost/?method=delete"

# Send as a PATCH request
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost/?method=patch"

La liste complète des méthodes prises en charge est : post (par défaut), get, put, delete, patch, head, update et options.

Remarque : Lorsque method=get est utilisé, le corps XML est toujours envoyé en tant que corps de la requête. Pour transmettre des paramètres sous forme de chaînes de requête URL, utilisez le préfixe - (voir Manipulation des Paramètres GET ci-dessous).

Manipulation de la Charge Utile

L’utilisation du : dans l’URL Apprise vous permet de modifier et d’ajouter du contenu publié en amont vers un serveur distant.

Remarque : Les noms d’éléments XML doivent être des identifiants valides. Tout caractère en dehors de [A-Za-z0-9_-] est automatiquement supprimé du nom :key.

# Add to the payload delivered to the remote server as if it was part
# the prepared message Apprise would have otherwise put together
#
# Assuming our {hostname} is localhost
# Assuming we want to include "Sound": "oceanwave" as part of the existing payload:
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost/?:Sound=oceanwave"

Ce qui précède publierait un message tel que :

<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Corps du Message>
        <Notification xmlns:xsi="http://nzbget.lead2gold.org/notify/NotifyXML-1.0.xsd">
            <Version>1.0</Version>
            <Subject>Titre du Message de Test</Subject>
            <MessageType>info</MessageType>
            <Message>Corps du Message de Test</Message>
            <Sound>oceanwave</Sound>
       </Notification>
    </soapenv:Corps du Message>
</soapenv:Envelope>

Vous pouvez également supprimer des éléments intégrés de la sortie en définissant leur valeur à vide :

# Remove the Version and MessageType elements from the payload:
# Assuming our {hostname} is localhost
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost/?:Version&:MessageType"

Ce qui précède publierait un message tel que :

<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Corps du Message>
        <Notification>
            <Subject>Titre du Message de Test</Subject>
            <Message>Corps du Message de Test</Message>
       </Notification>
    </soapenv:Corps du Message>
</soapenv:Envelope>

Remarque : Lorsqu’une personnalisation de la charge utile est appliquée (ajout, suppression ou remappage d’éléments), l’attribut d’espace de noms XSD est omis de l’élément <Notification>.

Enfin, vous pouvez remapper un élément intégré vers un nom de balise différent :

# Remap "Message" to "Corps du Message" and "Subject" to "Title":
# Assuming our {hostname} is localhost
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost/?:Message=Corps du Message&:Subject=Title"

Ce qui précède publierait un message tel que :

<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Corps du Message>
        <Notification>
            <Version>1.0</Version>
            <Title>Titre du Message de Test</Title>
            <MessageType>info</MessageType>
            <Corps du Message>Corps du Message de Test</Corps du Message>
       </Notification>
    </soapenv:Corps du Message>
</soapenv:Envelope>

Manipulation des En-têtes

Certains utilisateurs peuvent avoir besoin que des en-têtes HTTP spéciaux soient présents lors de la publication de leurs données vers leur serveur. Cela peut être accompli en plaçant simplement un symbole plus (+) devant tout paramètre que vous spécifiez dans votre chaîne URL.

# Below would set the header:
#    X-Token: abcdefg
#
# Assuming our {hostname} is localhost
# Assuming our {port} is 8080
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost:8080/path/?+X-Token=abcdefg"

# Multiple headers just require more entries defined:
# Below would set the headers:
#    X-Token: abcdefg
#    X-Apprise: is great
#
# Assuming our {hostname} is localhost
# Assuming our {port} is 8080
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost:8080/path/?+X-Token=abcdefg&+X-Apprise=is%20great"

Manipulation des Paramètres GET

Certains utilisateurs peuvent avoir besoin que des paramètres GET fassent partie de leur requête POST. Tout paramètre que vous transmettez sur la ligne de commande Apprise est interprété par Apprise lui-même comme des options/actions que vous souhaitez effectuer (comme changer method=update ou cto=3). Pour qu’Apprise ignore ce qui a été spécifié et transmette le contenu tel quel en amont, il vous suffit de préfixer vos entrées d’un symbole moins (-).

# The below for example would post to http://localhost:8000?token=abcdefg
#
# The `-` symbol will get stripped off when the upstream post takes place
# Apprise knows not to do anything with the argument at all and pass it along as is.
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xml://localhost:8080/?-token=abcdefg"

# If you want to pass more then one element, just chain them:
# The below would send a a POST to:
#  https://example.ca/my/path?key1=value1&key2=value2
#
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "xmls://example.ca/my/path?-key1=value1&-key2=value2"