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 plateformes API et facturez en fonction du nombre d’appels.

Limitation de Taux

Surveillez les modèles d’utilisation de l’API et mettez en œuvre une limitation de taux basée sur l’utilisation.

Surveillance des Performances

Suivez les temps de réponse et les taux d’erreur en parallèle des données de facturation.

SaaS Multi-Tenant

Facturez les clients en fonction de leur consommation API à travers différents points de terminaison.
Idéal pour suivre l’utilisation des points de terminaison API, la limitation de taux et mettre en œuvre 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

Installer le SDK

npm install @dodopayments/ingestion-blueprints
2

Obtenez vos Clés API

3

Créer un Compteur

Créez un compteur dans votre Tableau de Bord Dodo Payments :
  • Nom de l’Événement : api_call (ou votre nom préféré)
  • 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

Suivre les Appels API

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
required
Votre clé API Dodo Payments depuis le tableau de bord.
​
environment
string
required
Mode d’environnement : test_mode ou live_mode.
​
eventName
string
required
Nom de l’événement qui correspond à votre configuration de compteur.

​
Options de Suivi des Appels API

​
customerId
string
required
L’ID client pour l’attribution de facturation.
​
metadata
object
Métadonnées optionnelles 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 maximum d’événements avant le 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 un Fort Volume : Pour les applications gérant plus de 10 demandes par seconde, utilisez createBatch() pour réduire la surcharge 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.