Passer au contenu principal

​
Cas d’utilisation

Explorez les scénarios courants pris en charge par le Blueprint API Gateway :

API-as-a-Service

Suivez l’utilisation par client pour les plates-formes API et facturez en fonction du nombre d’appels.

Rate Limiting

Surveillez les modèles d’utilisation de l’API et mettez en œuvre des limitations de débit basées sur l’utilisation.

Performance Monitoring

Suivez les temps de réponse et les taux d’erreur parallèlement aux données de facturation.

Multi-Tenant SaaS

Facturez les clients en fonction de leur consommation d’API sur différents points de terminaison.
Idéal pour suivre l’utilisation des points de terminaison API, la limitation de débit et la mise en œuvre de la facturation API basée sur l’utilisation.

​
Démarrage Rapide

Suivez les appels API au niveau de la passerelle avec un traitement par lots automatique pour des scénarios à fort volume :
1

Install the SDK

npm install @dodopayments/ingestion-blueprints
2

Get Your API Keys

3

Create a Meter

Créez un compteur dans votre tableau de bord Dodo Payments :
  • Nom de l’événement : api_call (ou le nom de votre choix)
  • Type d’agrégation : count pour suivre le nombre d’appels
  • Configurez des propriétés supplémentaires si vous suivez des métadonnées comme les temps de réponse, les codes d’état, etc.
4

Track API Calls

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

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

// Track a single API call
await trackAPICall(ingestion, {
  customerId: 'customer_123',
  metadata: {
    endpoint: '/api/v1/users',
    method: 'GET',
    status_code: 200,
    response_time_ms: 45
  }
});

​
Configuration

​
Configuration d’Ingestion

​
apiKey
string
requis
Votre clé API Dodo Payments depuis le tableau de bord.
​
environment
string
requis
Mode d’environnement : test_mode ou live_mode.
​
eventName
string
requis
Nom de l’événement correspondant à la configuration de votre compteur.

​
Options de Suivi des Appels API

​
customerId
string
requis
L’identifiant client pour l’attribution de facturation.
​
metadata
object
Métadonnées facultatives sur l’appel API, comme le point de terminaison, la méthode, le code d’état, le temps de réponse, etc.

​
Configuration par Lots

​
maxSize
number
Nombre maximal d’événements avant vidage automatique. Par défaut : 100.
​
flushInterval
number
Intervalle de vidage automatique en millisecondes. Par défaut : 5000 (5 secondes).

​
Meilleures Pratiques

Utilisez le traitement par lots pour les gros volumes : pour les applications traitant plus de 10 requêtes par seconde, utilisez createBatch() pour réduire les frais généraux et améliorer les performances.
Nettoyez toujours les lots : appelez batch.cleanup() lors de l’arrêt de l’application pour vider les événements en attente et éviter la perte de données.