Aller au contenu

Notifications Notica

Aperçu

Notica ne vous oblige pas a creer un compte. Il vous suffit de visiter leur site web au moins une fois afin de :

  1. recuperer votre jeton ;
  2. activer les notifications du navigateur, qui seront ensuite envoyees depuis le site Notica.

Le site vous generera alors une URL de publication ressemblant a ceci : https://notica.us/?abc123

Cela correspond en pratique a : https://notica.us/?{token} Remarque : ignorez le point d’interrogation dans l’URL ; il ne fait pas partie du jeton.

A partir de la, vous avez deux possibilites : transmettre directement a Apprise l’URL Notica telle qu’elle apparait sur le site, ou la reconstruire dans le format Apprise, ce qui est legerement plus rapide a traiter : notica://{token}

La syntaxe valide est la suivante :

  • https://notica.us/?{token}
  • notica://{token}

Pour les solutions autohebergees, vous pouvez utiliser les variantes suivantes :

  • notica://{host}/{token}
  • notica://{host}:{port}/{token}
  • notica://{user}@{host}/{token}
  • notica://{user}@{host}:{port}/{token}
  • notica://{user}:{password}@{host}/{token}
  • notica://{user}:{password}@{host}:{port}/{token}
VariableObligatoireDescription
tokenOuiJeton genere pour vous apres votre visite sur le site web. Pour une instance autohebergee, il s’agit du jeton defini par votre propre solution.

Une solution autohebergee prend aussi en charge quelques parametres supplementaires :

VariableObligatoireDescription
hostnameOuiNom d’hote du serveur web.
portNonPort sur lequel votre serveur web ecoute. Par defaut, 80 est utilise pour notica:// et 443 pour toutes les references noticas://.
userNonSi votre systeme utilise HTTP-AUTH, vous pouvez fournir le username a utiliser pour l’authentification.
passwordNonSi votre systeme utilise HTTP-AUTH, vous pouvez fournir le password a utiliser pour l’authentification.
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.
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.

Envoyer une notification Notica :

Fenêtre de terminal
# Supposons que notre {token} soit abc123
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
notica://abc123

Les solutions autohebergees peuvent necessiter des en-tetes HTTP speciaux lors de l’envoi des donnees. Pour cela, il suffit d’ajouter un tiret (-) devant tout parametre precise dans votre URL.

Fenêtre de terminal
# L'exemple ci-dessous definirait l'en-tete :
# X-Token: abcdefg
#
# Supposons que notre {hostname} soit localhost
# Supposons que notre {token} soit abc123
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
"notica://localhost/abc123/?-X-Token=abcdefg"
# Pour plusieurs en-tetes, il suffit d'ajouter d'autres entrees prefixees par `-` :
# L'exemple ci-dessous definirait les en-tetes :
# X-Token: abcdefg
# X-Apprise: is great
#
# Supposons que notre {hostname} soit localhost
# Supposons que notre {token} soit abc123
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
"notica://localhost/abc123/?-X-Token=abcdefg&-X-Apprise=is%20great"
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

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

Conçu avec amour depuis le Canada