bytes additionne la bande passante de chaque client afin que vous puissiez la facturer. Le blueprint est fourni dans le package npm @dodopayments/ingestion-blueprints sous le nom trackStreamBytes().
Cas d’utilisation
Le Stream Blueprint convient aux scénarios suivants :Video Platforms
Facturez les clients en fonction de leur consommation de bande passante vidéo et de la qualité du streaming.
Music Streaming
Suivez l’utilisation du streaming audio par utilisateur pour les niveaux d’abonnement.
Live Events
Surveillez la consommation des diffusions en direct et facturez l’utilisation de la bande passante.
Real-Time Data
Suivez le transfert de données en temps réel pour les applications IoT et de télémétrie.
Utilisez-le pour les plateformes de streaming vidéo et audio, les services de diffusion en direct et les applications de données en temps réel.
Démarrage rapide
Pour suivre l’utilisation du streaming, installez le package, créez un compteur et envoyez le nombre d’octets consommés par chaque client.1
Install the SDK
Installez le package Dodo Payments Ingestion Blueprints :
2
Get Your API Keys
Créez une clé API Dodo Payments sous Developer → API Keys dans le tableau de bord Dodo Payments, puis stockez-la dans la variable d’environnement
DODO_PAYMENTS_API_KEY. Utilisez une clé de mode test pendant le développement. Une clé de mode test fonctionne uniquement avec test_mode.3
Create a Meter
Dans le tableau de bord Dodo Payments, accédez à Products → Meters et cliquez sur Create Meter. Définissez les champs suivants :
- Meter Name : un nom descriptif, tel que
Stream Bandwidth. - Event Name :
stream_consumption, ou un nom de votre choix. Il doit correspondre exactement àeventNamedans votre code (sensible à la casse). - Aggregation Type : Sum, pour additionner les octets transmis.
- Over Property :
bytes, afin de facturer selon l’utilisation de la bande passante. - Measurement Unit : l’unité affichée sur les factures, telle que
bytes.
4
Track Stream Usage
Appelez
trackStreamBytes() avec le client et le nombre d’octets consommés :Configuration
Configuration de l’ingestion
Transmettez ces options ànew Ingestion() :
string
requis
Votre clé API Dodo Payments issue du tableau de bord.
string
Mode d’environnement :
test_mode ou live_mode. La valeur par défaut est test_mode. Les SDK Dodo Payments utilisent par défaut live_mode à la place ; définissez donc explicitement live_mode en production.string
requis
Nom de l’événement correspondant au Event Name de votre compteur (sensible à la casse).
Options de suivi des octets du flux
Transmettez ces options àtrackStreamBytes() :
string
requis
Identifiant client Dodo Payments à facturer pour le flux, par exemple
cus_123.number
Nombre d’octets consommés dans le flux. Requis pour la facturation basée sur la bande passante. Si vous l’omettez, l’événement ne contient aucune valeur
bytes, mais il est tout de même comptabilisé par un compteur Count.object
Métadonnées facultatives sur le flux, telles que son type, sa qualité ou l’ID de session. Chaque valeur doit être une chaîne, un nombre ou une valeur booléenne.
Bonnes pratiques
Chaque appel àtrackStreamBytes() envoie un événement distinct, et un compteur Sum additionne les segments.