Notifications Streamlabs

Aperçu

• Source: https://streamlabs.com/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 32768
• Format(s) de message pris en charge:
  • ✓TEXT
• Créer votre URL Apprise

Configuration du Compte

La procédure d’inscription à Streamlabs est un peu longue.

Remarque : les captures d’écran et instructions ci-dessous sont entièrement créditées 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 à Streamlabs.

1. Connectez-vous à Streamlabs.
2. Accédez à la page des paramètres API pour enregistrer une application :
   
   
   
3. Remplissez le formulaire avec n’importe quelles valeurs acceptées comme valides. La plupart des champs peuvent contenir du texte arbitraire, car l’application n’est pas censée dépasser le stade “testing” et sert uniquement à un usage personnel. Dans le champ “Whitelist Users”, saisissez le nom d’utilisateur d’un compte Twitch que vous contrôlez. Même si cette fonctionnalité est techniquement limitée à Twitch, vous pouvez aussi utiliser l’overlay d’alertes pour les dons sur YouTube et Facebook. Pour l’instant, définissez simplement la “Redirect URI” sur http://localhost, vous la modifierez ensuite. Cliquez ensuite sur create :
   
4. Récupérons maintenant le Client ID depuis la page Streamlabs afin de générer un code qui sera utilisé par Apprise pour communiquer avec Streamlabs. Remplacez les espaces réservés 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 redirigé vers localhost. Copiez le code présent dans les paramètres d’URL affichés dans la barre d’adresse du navigateur : http://localhost/?code=<YOURCODE>
5. Générez ensuite un jeton d’accès à l’aide du code obtenu à l’étape précédente, de votre Client ID et de votre Secret. Ouvrez un terminal et effectuez une requête pour générer le jeton d’accès 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 être retourné : {"access_token":<YOURACCESSTOKEN>,"token_type":"Bearer","expires_in":3600,"refresh_token":""} Notez que le jeton d’accès n’expire pas.

1. Copiez ensuite votre jeton d’accès 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’accès généré depuis votre compte Streamlabs.

Paramètres Globaux

Variable	Description
overflow	Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream. 👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite. 👉 truncate : conserve la partie qui tient dans la limite et supprime le reste. 👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre. Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact.
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é. Le résultat global de notify() est quand même considéré comme réussi 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.

Note

L’affichage de votre titre et de votre corps de message dépend du type d’appel :

• Alertes : le titre est l’en-tête principal et le corps s’affiche en dessous. Sans titre, le corps devient l’en-tête principal.
• Dons : il n’existe pas de champ titre, le titre est donc placé sur la première ligne du message de don. Le message complet reste sous la limite de 255 caractères.

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/