Aller au contenu

Notifications Pushed

Aperçu

Lors de votre premiere connexion au site, vous devrez demander l’option Request Developer Access. Pensez a verifier votre e-mail, car vous devrez valider votre compte.

Une fois cela fait, vous aurez acces a la section apps, ou vous pourrez creer une nouvelle application si vous n’en avez pas encore.

Vous aurez alors acces aux informations suivantes :

  • Application Key: {app_key}
  • Application Secret: {app_secret}

Vous devrez aussi disposer d’une cible a notifier. Une fois votre compte et votre application crees, telechargez egalement leur application mobile, sur Android ou iOS, puis connectez-vous.

Abonnez-vous a cette application ; un Subscription Link est disponible directement dans la page de parametres de l’application que vous venez de creer. Vous aurez besoin d’au moins un abonnement pour utiliser ce service de notification.

La syntaxe valide est la suivante :

  • pushed://{app_key}/{app_secret}
  • pushed://{app_key}/{app_secret}/@{user_pushed_id}
  • pushed://{app_key}/{app_secret}/@{user_pushed_id1}/@{user_pushed_id2}/@{user_pushed_idN}
  • pushed://{app_key}/{app_secret}/#{channel_alias}
  • pushed://{app_key}/{app_secret}/#{channel_alias1}/#{channel_alias2}/#{channel_aliasN}

Vous pouvez egalement combiner les formes ci-dessus et effectuer les mises a jour depuis une seule URL :

  • pushed://{app_key}/{app_secret}/@{user_pushed_id}/#{channel_alias}/

Si ni @{user_pushed_id} ni #{channel} ne sont precises, la configuration par defaut consiste a envoyer simplement vers l’App pour laquelle vous avez fourni les cles.

VariableObligatoireDescription
app_keyOuiApplication Key generee depuis la page de parametres de votre compte Pushed. Vous devez disposer d’une application key pour utiliser ce service de notification.
app_secretOuiApplication Secret generee depuis la page de parametres de votre compte Pushed. Vous devez disposer d’une application secret pour utiliser ce service de notification.
user_pushed_idNonLes utilisateurs doivent etre prefixes par un caractere arobase, @, sinon ils seront ignores. Vous pouvez ici identifier les utilisateurs par leur Pushed ID.
channel_aliasNonLes canaux doivent etre prefixes par un hashtag, #, sinon ils seront ignores. Les canaux doivent aussi etre enregistres dans votre compte Pushed pour fonctionner. Il doit s’agir de l’alias du canal lui-meme, et non du canal. Cet alias peut etre recupere depuis les parametres du canal dans votre compte pushed.io.
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 Pushed :

Fenêtre de terminal
# Supposons que notre {app_key} soit sopJo0dVKVC9YK1F5wDQ
# Supposons que notre {app_secret} soit KWEtXxVm1PtDTTrKaEM49DhBd8MJvSMCHSvunPerbCf1MaNLO300roqOL0F8HErAl
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
pushed://sopJo0dVKVC9YK1F5wDQ/KWEtXxVm1PtDTTrKaEM49DhBd8MJvSMCHSvunPerbCf1MaNLO300roqOL0F8HErAl
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