Notifications Spontit
Configuration du compte
Section intitulée « Configuration du compte »- Visitez https://spontit.com pour creer votre compte.
- Pour recuperer votre
{user}: rendez-vous sur votre profil a https://spontit.com/profile et notez votre User ID. Il ressemblera a quelque chose commeuser12345678901. - Pour recuperer votre
{apikey}: generez une cle API sur https://spontit.com/secret_keys, si ce n’est pas deja fait.
Les canaux sont facultatifs ; si aucun canal n’est precise, vous serez simplement notifie personnellement.
La syntaxe valide est la suivante :
spontit://{user}@{apikey}spontit://{user}@{apikey}/{channel_id}spontit://{user}@{apikey}/{channel_id1}/{channel_id2}/{channel_idN}/
Détail des Paramètres
Section intitulée « Détail des Paramètres »| Variable | Obligatoire | Description |
|---|---|---|
| user | Oui | User ID associe a votre compte Spontit. Il peut etre trouve sur votre page de profil Spontit. |
| apikey | Oui | Cle API que vous avez generee pour votre compte Spontit. Elle peut etre trouvee, et generee si necessaire, ici. |
| channel_id | Non | Canal que vous souhaitez notifier et que vous avez cree vous-meme. |
| subtitle | Non | Sous-titre de votre push. Il n’apparait que sur les appareils iOS. |
Paramètres Globaux
Section intitulée « 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. |
| 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é. L’appel global notify() retourne quand même True 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
Section intitulée « Exemples »Envoyer une notification Spontit a tous les appareils associes a un projet :
# Supposons :# - que notre {user} soit user28635710302# - que notre {apikey} soit a6k4ABnck26hDh8AA3EDHoOVdDEUlw3ntyapprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \ spontit://user28635710302@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
# Pour remplacer le sous-titre, sur iOS uniquement, faites comme suit :# Vous devez utiliser des chaines encodees en URL, ci-dessous les espaces sont remplaces par %20apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \ spontit://myuser@myapi?subtitle=A%20Different%20Subtitle 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