Stream Blueprint

Stream Blueprint skickar en användningshändelse till Dodo Payments med antalet byte som en kund förbrukade från en ström. En Sum-mätare över bytes summerar varje kunds bandbredd, så att du kan debitera för den. Blueprint ingår i npm-paketet @dodopayments/ingestion-blueprints som trackStreamBytes().

Användningsfall

Stream Blueprint passar för följande scenarier:

Video Platforms

Debitera kunder för videobandbredd och streamingkvalitet.

Music Streaming

Spåra ljudstreaming per användare för prenumerationsnivåer.

Live Events

Övervaka förbrukning av liveströmmar och debitera för bandbreddsanvändning.

Real-Time Data

Spåra realtidsdataöverföring för IoT- och telemetritillämpningar.

Använd den för plattformar för video- och ljudstreaming, tjänster för livesändningar och realtidsdatatillämpningar.

Snabbstart

Om du vill spåra streaminganvändning installerar du paketet, skapar en mätare och skickar antalet byte som varje kund förbrukar.

Install the SDK

Installera paketet Dodo Payments Ingestion Blueprints:

npm install @dodopayments/ingestion-blueprints

Get Your API Keys

Skapa en Dodo Payments API-nyckel under Developer → API Keys i Dodo Payments dashboard och lagra den i miljövariabeln DODO_PAYMENTS_API_KEY. Använd en nyckel i testläge medan du bygger. En nyckel i testläge fungerar endast med test_mode.

Create a Meter

I Dodo Payments dashboard går du till Products → Meters och klickar på Create Meter. Ange följande fält:

Meter Name: ett beskrivande namn, till exempel Stream Bandwidth.
Event Name: stream_consumption eller ett namn som du väljer. Det måste exakt matcha eventName i koden (skiftlägeskänsligt).
Aggregation Type: Sum, för att summera de streamade byten.
Over Property: bytes, för att debitera baserat på bandbreddsanvändning.
Measurement Unit: enheten som visas på fakturor, till exempel bytes.

Track Stream Usage

Anropa trackStreamBytes() med kunden och antalet förbrukade byte:

import { Ingestion, trackStreamBytes } from '@dodopayments/ingestion-blueprints';

const ingestion = new Ingestion({
  apiKey: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode',
  eventName: 'stream_consumption'
});

// Track video stream consumption
await trackStreamBytes(ingestion, {
  customerId: 'cus_123',
  bytes: 10485760, // 10MB
  metadata: {
    stream_type: 'video',
  }
});

Konfiguration

Ingestion-konfiguration

Skicka följande alternativ till new Ingestion():

string

obligatorisk

Din Dodo Payments API-nyckel från dashboarden.

string

Miljöläge: test_mode eller live_mode. Standardvärdet är test_mode. Dodo Payments SDK:er använder däremot live_mode som standard, så ange live_mode uttryckligen i produktion.

string

obligatorisk

Händelsenamnet som matchar mätarens Event Name (skiftlägeskänsligt).

Alternativ för Track Stream Bytes

Skicka följande alternativ till trackStreamBytes():

string

obligatorisk

Dodo Payments-kund-ID:t som ska debiteras för strömmen, till exempel cus_123.

number

Antalet byte som förbrukats i strömmen. Krävs för bandbreddsbaserad debitering. Om du utelämnar det har händelsen inget värde för bytes, men den räknas fortfarande med i en Count-mätare.

object

Valfria metadata om strömmen, till exempel strömtyp, kvalitet eller sessions-ID. Varje värde måste vara en sträng, ett tal eller ett booleskt värde.

Bästa praxis

Spåra per segment: För långa strömmar bör du spåra förbrukningen i segment i stället för att vänta tills hela strömmen har slutförts.

Varje anrop till trackStreamBytes() skickar en separat händelse, och en Sum-mätare summerar segmenten.

Noggrann byte-räkning: Om du debiterar för total bandbredd ska du inkludera all overhead, till exempel headers och protokolloverhead, i dina byteberäkningar.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Användningsfall

Video Platforms

Music Streaming

Live Events

Real-Time Data

Snabbstart

Konfiguration

Ingestion-konfiguration

Alternativ för Track Stream Bytes

Bästa praxis

​Användningsfall

Video Platforms

Music Streaming

Live Events

Real-Time Data

​Snabbstart

​Konfiguration

​Ingestion-konfiguration

​Alternativ för Track Stream Bytes

​Bästa praxis

Användningsfall

Snabbstart

Konfiguration

Ingestion-konfiguration

Alternativ för Track Stream Bytes

Bästa praxis