Chuyển đến nội dung chính

​
Trường Hợp Sử Dụng

Khám phá các kịch bản phổ biến được hỗ trợ bởi API Gateway Blueprint:

API-as-a-Service

Theo dõi mức sử dụng theo khách hàng cho các nền tảng API và tính phí dựa trên số lượng cuộc gọi.

Giới Hạn Tốc Độ

Giám sát các mẫu sử dụng API và thực hiện giới hạn tốc độ dựa trên mức sử dụng.

Giám Sát Hiệu Suất

Theo dõi thời gian phản hồi và tỷ lệ lỗi cùng với dữ liệu thanh toán.

SaaS Đa Thuê

Tính phí khách hàng dựa trên mức tiêu thụ API của họ qua các điểm cuối khác nhau.
Lý tưởng cho việc theo dõi mức sử dụng điểm cuối API, giới hạn tốc độ và thực hiện thanh toán API dựa trên mức sử dụng.

​
Bắt Đầu Nhanh

Theo dõi các cuộc gọi API ở cấp cổng với việc tự động nhóm cho các kịch bản có khối lượng lớn:
1

Cài Đặt SDK

npm install @dodopayments/ingestion-blueprints
2

Lấy API Keys Của Bạn

3

Tạo Một Đồng Hồ

Tạo một đồng hồ trong Bảng Điều Khiển Dodo Payments:
  • Tên Sự Kiện: api_call (hoặc tên bạn chọn)
  • Loại Tập Hợp: count để theo dõi số lượng cuộc gọi
  • Cấu hình các thuộc tính bổ sung nếu theo dõi siêu dữ liệu như thời gian phản hồi, mã trạng thái, v.v.
4

Theo Dõi Các Cuộc Gọi 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
  }
});

​
Cấu Hình

​
Cấu Hình Nhập Dữ Liệu

​
apiKey
string
required
API key Dodo Payments của bạn từ bảng điều khiển.
​
environment
string
required
Chế độ môi trường: test_mode hoặc live_mode.
​
eventName
string
required
Tên sự kiện phù hợp với cấu hình đồng hồ của bạn.

​
Tùy Chọn Theo Dõi Cuộc Gọi API

​
customerId
string
required
ID khách hàng để phân bổ thanh toán.
​
metadata
object
Siêu dữ liệu tùy chọn về cuộc gọi API như điểm cuối, phương thức, mã trạng thái, thời gian phản hồi, v.v.

​
Cấu Hình Nhóm

​
maxSize
number
Số lượng sự kiện tối đa trước khi tự động xả. Mặc định: 100.
​
flushInterval
number
Thời gian tự động xả trong mili giây. Mặc định: 5000 (5 giây).

​
Thực Hành Tốt Nhất

Sử Dụng Nhóm Cho Khối Lượng Lớn: Đối với các ứng dụng xử lý hơn 10 yêu cầu mỗi giây, hãy sử dụng createBatch() để giảm tải và cải thiện hiệu suất.
Luôn Dọn Dẹp Các Nhóm: Gọi batch.cleanup() khi ứng dụng tắt để xả các sự kiện đang chờ và ngăn ngừa mất dữ liệu.