Notifications Custom JSON

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 simplement d’une notification personnalisee qui permet a cet outil de publier vers un serveur web sous la forme d’une simple chaine JSON. C’est utile pour les personnes qui souhaitent etre notifiees via leurs propres methodes personnalisees.

Le format peut ressembler a ceci :

{
  "version": "1.0",
  "title": "Some Great Software Downloaded Successfully",
  "message": "Plenty of details here",
  "type": "info"
}

Le type prendra l’une des valeurs suivantes :

• info : message de type informatif
• success : rapport de succes
• failure : rapport d’echec
• warning : avertissement

Syntaxe

La syntaxe valide est la suivante :

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

L’ajout d’un s au schema, c’est-a-dire jsons://, bascule vers une connexion HTTPS securisee :

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

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 json:// et 443 pour toutes les references jsons://.
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.
method	Non	Permet facultativement de preciser la methode HTTP du serveur ; les options possibles sont post, put, get, delete, patch, head, update et options. Si aucune methode n’est precisee, post est utilise par defaut.

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 JSON a notre serveur web a l’ecoute sur le port 80 :

# Supposons que notre {hostname} soit json.server.local
apprise json://json.server.local

Methode HTTP

Par defaut, toutes les notifications sont envoyees en POST. Remplacez ce comportement avec le parametre d’URL method :

# Envoyer comme requete PUT
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost/?method=put"

# Envoyer comme requete DELETE
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost/?method=delete"

# Envoyer comme requete PATCH
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost/?method=patch"

La liste complete des methodes prises en charge est : post, par defaut, get, put, delete, patch, head, update et options.

Remarque : lorsque method=get est utilise, le corps JSON est tout de meme envoye comme corps de requete. Pour transmettre les parametres a la place sous forme de chaine de requete dans l’URL, utilisez le prefixe -, voir Manipulation des Parametres GET ci-dessous.

Manipulation de la Charge Utile

L’utilisation de : dans l’URL Apprise vous permet de modifier et d’ajouter du contenu a ce qui est publie en amont vers un serveur distant.

# Ajouter a la charge utile envoyee au serveur distant comme si cela
# faisait partie du message qu'Apprise aurait autrement prepare
#
# Supposons que notre {hostname} soit localhost
# Supposons que nous voulions inclure `"sound": "oceanwave"` dans la charge utile existante :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost/?:sound=oceanwave"

L’exemple ci-dessus publierait un message comme celui-ci :

{
  "version": "1.0",
  "title": "Titre du Message de Test",
  "message": "Corps du Message de Test",
  "type": "info",
  "sound": "oceanwave"
}

Vous pouvez aussi supprimer des entrees en definissant leur valeur comme vide :

# Vider version et type de la charge utile :
# Supposons que notre {hostname} soit localhost
# Supposons que nous voulions retirer version et type de la sortie :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost/?:version&:type"

L’exemple ci-dessus publierait un message comme celui-ci :

{
  "title": "Titre du Message de Test",
  "message": "Corps du Message de Test"
}

Enfin, vous pouvez remapper des valeurs, par exemple en envoyant le message dans une cle body a la place :

# Ajouter a la charge utile envoyee au serveur distant comme si cela
# faisait partie du message qu'Apprise aurait autrement prepare
#
# Supposons que notre {hostname} soit localhost
# Supposons que nous voulions remapper la section message vers body :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost/?:message=body"

L’exemple ci-dessus publierait un message comme celui-ci :

{
  "version": "1.0",
  "title": "Titre du Message de Test",
  "body": "Corps du Message de Test",
  "type": "info"
}

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
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost:8080/path/?+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
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost:8080/path/?+X-Token=abcdefg&+X-Apprise=is%20great"

Manipulation des Parametres GET

Certains utilisateurs peuvent avoir besoin que des parametres GET fassent partie de leur POST. Tous les parametres que vous passez a la ligne de commande Apprise sont interpretes par Apprise lui-meme comme des options ou actions a executer, comme method=update ou cto=3. Pour qu’Apprise ignore ce qui a ete precise et transmette le contenu tel quel en amont, il suffit de prefixer vos entrees avec un symbole moins, -.

# L'exemple ci-dessous publierait vers http://localhost:8000?token=abcdefg
#
# Le symbole `-` sera retire lors de l'envoi en amont
# Apprise sait qu'il ne doit pas traiter cet argument et qu'il doit le transmettre tel quel.
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "json://localhost:8080/?-token=abcdefg"

# Si vous voulez transmettre plus d'un element, il suffit de les enchainer :
# L'exemple ci-dessous enverrait un POST vers :
#  https://example.ca/my/path?key1=value1&key2=value2
#
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "jsons://example.ca/my/path?-key1=value1&-key2=value2"