Retour au blog

Publié le·Par l'équipe DonoLink·5 min de lecture

Une API de don pour les streamers : créez vos propres outils avec DonoLink

Utilisez l'API DonoLink pour les dons, les abonnés et les événements historiques en streaming. Découvrez des applications, des clés API et des exemples pour votre propre intégration.

#api#developers#activity feed#donaties#integraties

Votre tableau de bord par défaut n'est pas toujours l'écran que vous voyez devant vous lors d'une diffusion en direct. Peut-être travaillez-vous avec votre propre interface de contrôle, il y a un petit moniteur à côté de votre caméra ou vous créez vous-même une application pour votre stream. Une API de don vous permet d'utiliser l'activité de votre chaîne dans cet environnement. Le API du développeur DonoLink vous donne un accès personnel en lecture aux dons et aux événements de flux enregistrés.

De votre stream d'activité à votre propre application

L'API rassemble deux sources de données : les dons payés de DonoLink, y compris l'historique importé, et les événements que DonoLink a stockés via les liens de votre plateforme. Pensez aux suivis, aux abonnements, aux abonnés doués, aux acclamations et aux raids. Les dons de plateformes déjà enregistrés, comme YouTube Super Chat, peuvent également figurer dans le flux. Vous n'êtes pas obligé de traiter les différentes sources dans un format de réponse différent.

Chaque événement a un identifiant reconnaissable, une plate-forme, un type, un nom d'écran, un message et une valeur numérique avec une unité. Cela vous permet par exemple d'afficher les dons sur votre propre écran, de créer une rétrospective d'un stream ou de construire un compteur personnel d'abonnements cadeaux. Vérifiez toujours l'unité : les diamants TikTok ne sont pas des euros, et le nombre de spectateurs d'un raid n'est pas un montant de don.

Trois applications pour les streamers et les développeurs

  • Votre propre écran de contrôle. Affichez les dons et événements pertinents à côté de votre caméra et des commandes de scène. Filtrez par plateforme ou type d'événement qui est important à ce moment-là.
  • Une application mobile personnelle. Afficher un stream compact pendant un stream IRL. Enregistrez votre progression afin de pouvoir relire les événements enregistrés après une interruption de connexion.
  • Un aperçu après votre stream. Lisez une période définie pour votre propre récapitulatif. Gardez les dons, les abonnements et les autres valeurs de la plateforme séparés dans votre analyse.

Ce sont des applications que vous pouvez créer vous-même. L'API fournit les données ; Cela n’installe pas automatiquement une application mobile complète ou une intégration tierce prête à l’emploi. Pour une alerte OBS régulière, vous pouvez utiliser le Overlays DonoLink continuer à utiliser.

Voici comment commencer votre première requête API

  1. Faites-en un Compte DonoLink et complétez votre intégration.
  2. Ouvrez Paramètres et faites défiler jusqu'à Développeur. Créez une clé API pour votre intégration.
  3. Stockez la clé dans la configuration secrète de votre serveur. Envoyez-le en tant que jeton Bearer dans l’en-tête Authorization.
  4. Vérifiez auprès de OBTENIR /api/v1/moi quel compte appartient à votre clé. Alors lis OBTENIR /api/v1/activité .

Le Documentation API contient une requête curl initiale, un exemple JSON et une spécification OpenAPI téléchargeable. Vous pouvez lire un maximum de 100 événements par page. Vous pouvez demander les pages suivantes via le curseur, sans limite fixe sur le nombre de pages historiques. La limite du compte est de 120 requêtes toutes les 60 secondes, partagées par toutes les clés.

Une clé privée avec des droits limités

Une clé donne accès à votre propre compte et n'a que la portée activité:lire . Vous n'avez aucun droit de modifier les dons, d'ajuster vos paramètres ou d'effectuer des retraits. DonoLink stocke un hachage de la clé. Vous ne pouvez voir la clé complète qu'immédiatement après l'avoir créée ; plus tard, vous le retirez ou créez un remplacement.

Ces droits limités rendent toujours une clé confidentielle : les pseudonymes et les messages de don peuvent contenir des données personnelles. Ne le placez pas dans le code de votre site Web public, dans le référentiel Git ou dans l'image de flux. Pour une application native personnelle, utilisez un stockage sécurisé. Pour une application avec plusieurs utilisateurs, séparez les secrets par compte. Un lien OAuth pour de telles applications n'est pas encore disponible dans la v1.

Ce qu’il faut savoir à l’avance sur l’histoire

L'API lit ce que DonoLink a réellement stocké. Un nouveau lien de plateforme ne récupère pas automatiquement tous les anciens suivis ou abonnements sur Twitch, YouTube, Kick ou TikTok. Les dons importés sont reconnaissables à leur source d’importation. Les dons entièrement remboursés ou contestés et les alertes de test sont absents du flux. Par conséquent, utilisez-le pour votre activité, et non comme relevé bancaire ou comptable.

Vous souhaitez continuer à mettre à jour pendant votre diffusion ? Lire le guide pour un stream d'activité dans votre application IRL . Il explique comment combiner l'interrogation, les pages historiques et la récupération après perte du réseau. Dans le référence pour l'historique et le flux en direct vous trouverez l'exemple de code correspondant.

Questions fréquemment posées

Que puis-je faire avec l'API DonoLink ?

Vous pouvez lire votre propre profil et le flux d'activités enregistré. Le flux combine les dons, l’historique des dons importés et les événements reçus des plateformes de streaming liées. L'API dispose d'autorisations en lecture seule.

Où créer une clé API DonoLink ?

Au bas des paramètres se trouve Développeur. Ouvrez les clés API, donnez un nom à votre intégration et choisissez une validité de 30, 90 ou 365 jours. La clé entière est visible une fois.

Puis-je utiliser l'API en remplacement de Stripe ?

Non. L’API lit l’activité et n’émet aucun paiement. Le flux n'est pas un grand livre financier et ne renvoie pas de secrets Stripe ni d'informations de paiement.