Notifications Streamlabs

Aperçu

• Source: https://streamlabs.com/
• Prise en charge des images: Oui
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du Compte

La procedure d’inscription a Streamlabs est un peu longue.

Remarque : les captures d’ecran et instructions ci-dessous sont entierement creditees au Projet LNBits (disponible ici).

Pour le moment, le seul service disposant d’une API ouverte exploitable ici est Streamlabs. Cette configuration exige donc de lier votre compte Twitch, YouTube ou Facebook a Streamlabs.

1. Connectez-vous a Streamlabs.
2. Accedez a la page des parametres API pour enregistrer une application :
   
   
   
3. Remplissez le formulaire avec n’importe quelles valeurs acceptees comme valides. La plupart des champs peuvent contenir du texte arbitraire, car l’application n’est pas censee depasser le stade “testing” et sert uniquement a un usage personnel. Dans le champ “Whitelist Users”, saisissez le nom d’utilisateur d’un compte Twitch que vous controlez. Meme si cette fonctionnalite est techniquement limitee a Twitch, vous pouvez aussi utiliser l’overlay d’alertes pour les dons sur YouTube et Facebook. Pour l’instant, definissez simplement la “Redirect URI” sur http://localhost, vous la modifierez ensuite. Cliquez ensuite sur create :
   
4. Recuperons maintenant le Client ID depuis la page Streamlabs afin de generer un code qui sera utilise par Apprise pour communiquer avec Streamlabs. Remplacez les espaces reserves dans le lien ci-dessous par votre Client ID : https://www.streamlabs.com/api/v1.0/authorize?client_id=<YOURCLIENTID>&redirect_uri=http://localhost&response_type=code&scope=donations.read+donations.create+alerts.create Vous serez redirige vers localhost. Copiez le code present dans les parametres d’URL affiches dans la barre d’adresse du navigateur : http://localhost/?code=<YOURCODE>
5. Generez ensuite un jeton d’acces a l’aide du code obtenu a l’etape precedente, de votre Client ID et de votre Secret. Ouvrez un terminal et effectuez une requete pour generer le jeton d’acces qu’Apprise utilisera :

curl --request POST --url 'https://streamlabs.com/api/v1.0/token' -d  'grant_type=authorization_code&code=<YOURCODE>&client_id=<YOURCLIENTID>&client_secret=<YOURSECRET>&redirect_uri=http%3A%2F%2Flocalhost'

Un JSON similaire devrait etre retourne : {"access_token":<YOURACCESSTOKEN>,"token_type":"Bearer","expires_in":3600,"refresh_token":""} Notez que le jeton d’acces n’expire pas.

1. Copiez ensuite votre jeton d’acces pour construire l’URL Streamlabs : strmlabs://<YOURACCESSTOKEN>/?call=DONATIONS

Syntaxe

La syntaxe valide est la suivante :

• strmlabs://{access_token}/

Détail des Paramètres

Variable	Obligatoire	Description
access_token	Oui	Jeton d’acces genere depuis votre compte Streamlabs.

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 Streamlabs :

# Supposons que notre {access_token} soit abcdefghij1234567890
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   strmlabs://abcdefghij1234567890/