Chuyển đến nội dung chính
Dodo Payments cung cấp tính năng đồng bộ cơ sở dữ liệu tích hợp sẵn, tự động đồng bộ hóa dữ liệu thanh toán của bạn với cơ sở dữ liệu của riêng bạn. Bạn có thể đồng bộ thanh toán, khách hàng, đăng ký, và giấy phép để duy trì một bản sao cục bộ của dữ liệu của bạn cho phân tích, báo cáo hoặc tích hợp với các hệ thống khác.
Implementation: Có sẵn qua npm package | Source Code: GitHub

​
Bạn có thể đồng bộ những gì?

Tính năng đồng bộ cơ sở dữ liệu của chúng tôi hỗ trợ đồng bộ hóa các thực thể Dodo Payments sau đây với cơ sở dữ liệu của bạn:

Payments

Đồng bộ tất cả giao dịch thanh toán, bao gồm thanh toán một lần, hoàn tiền và cập nhật trạng thái thanh toán.

Customers

Giữ dữ liệu khách hàng đồng bộ, bao gồm hồ sơ khách hàng, thông tin liên hệ và siêu dữ liệu.

Subscriptions

Đồng bộ dữ liệu đăng ký, bao gồm các đăng ký đang hoạt động, chu kỳ thanh toán và thay đổi trạng thái đăng ký.

Licenses

Đồng bộ thông tin giấy phép, bao gồm khóa giấy phép, kích hoạt và cập nhật trạng thái giấy phép.
Bạn có thể đồng bộ bất kỳ tổ hợp thực thể nào trong số này bằng cách chỉ định chúng trong tham số scopes. Tất cả hoạt động đồng bộ đều là tăng dần và chỉ truyền các bản ghi mới hoặc đã được cập nhật để tối ưu hiệu năng.

​
Hỗ trợ cơ sở dữ liệu

Chúng tôi hiện hỗ trợ MongoDB, PostgreSQL, MySQL, và ClickHouse. Chúng tôi đang tích cực làm việc để mở rộng hỗ trợ cho:
  • Cơ sở dữ liệu: Snowflake và các cơ sở dữ liệu khác.
  • Pipelines: Pipelines ETL, đồng bộ thời gian thực.
Chúng tôi liên tục mở rộng hỗ trợ cơ sở dữ liệu. Nếu bạn muốn đóng góp một tích hợp cơ sở dữ liệu mới, vui lòng gửi Pull Request tới GitHub repository.

​
Bắt đầu

Bạn có thể sử dụng tính năng đồng bộ cơ sở dữ liệu của chúng tôi qua CLI hoặc lập trình trong mã của bạn. Cả hai phương pháp đều cung cấp cùng một chức năng—chọn phương pháp phù hợp nhất với quy trình làm việc của bạn.

​
Sử dụng CLI

Công cụ CLI cung cấp một cách nhanh chóng để thiết lập và chạy đồng bộ cơ sở dữ liệu. Cài đặt nó toàn cầu để sử dụng từ bất kỳ đâu trong terminal của bạn: 
npm install -g dodo-sync

​
Chạy CLI

CLI hỗ trợ hai chế độ: Chế độ tương tác cho thiết lập hướng dẫn, và Chế độ thủ công cho cấu hình trực tiếp. Chế độ tương tác: Chỉ cần chạy lệnh mà không có tham số để bắt đầu trình hướng dẫn thiết lập tương tác. 
dodo-sync
Chế độ thủ công: Truyền tham số trực tiếp để bỏ qua trình hướng dẫn. 
dodo-sync -i [interval] -d [database] -u [database_uri] --scopes [scopes] --api-key [api_key] --env [environment]
Ví dụ: 
# MongoDB
dodo-sync -i 600 -d mongodb -u mongodb://mymongodb.url --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode

# PostgreSQL
dodo-sync -i 600 -d postgres -u postgresql://user:password@localhost:5432/mydb --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode

# MySQL
dodo-sync -i 600 -d mysql -u mysql://user:password@localhost:3306/mydb --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode

# ClickHouse
dodo-sync -i 600 -d clickhouse -u http://localhost:8123 --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode

​
Tham số CLI

​
--interval
number
Khoảng thời gian đồng bộ tính bằng giây. Xác định tần suất vận hành đồng bộ. Nếu không cung cấp, đồng bộ sẽ chạy một lần và kết thúc.
​
--database
string
bắt buộc
Loại cơ sở dữ liệu cần sử dụng. Các giá trị hỗ trợ: "mongodb", "postgres", "mysql", hoặc "clickhouse".
​
--database-uri
string
bắt buộc
URI kết nối cho cơ sở dữ liệu của bạn:
  • MongoDB: mongodb://localhost:27017 hoặc mongodb+srv://user:pass@cluster.mongodb.net/
  • PostgreSQL: postgresql://user:password@localhost:5432/mydb
  • MySQL: mysql://user:password@localhost:3306/mydb
  • ClickHouse: http://localhost:8123
​
--scopes
string
bắt buộc
Danh sách các thực thể cần đồng bộ, cách nhau bằng dấu phẩy. Các phạm vi khả dụng: licences, payments, customers, subscriptions. Ví dụ: "payments,customers".
​
--api-key
string
bắt buộc
Khóa API Dodo Payments của bạn. Nên bắt đầu bằng dp_live_ cho chế độ sản xuất hoặc dp_test_ cho chế độ thử nghiệm.
​
--env
string
bắt buộc
Môi trường đích. Phải là "live_mode" hoặc "test_mode". Điều này xác định môi trường Dodo Payments để đồng bộ.
​
--rate-limit
number
Giới hạn tốc độ theo số yêu cầu mỗi giây. Kiểm soát tốc độ mà bộ đồng bộ gửi yêu cầu API để tránh làm quá tải API Dodo Payments.

​
Sử dụng trong mã của bạn

Để kiểm soát lập trình, tích hợp tính năng đồng bộ trực tiếp vào ứng dụng của bạn. Cài đặt nó như một phụ thuộc trong dự án của bạn: 
npm install dodo-sync

​
Đồng bộ tự động (dựa trên khoảng thời gian)

Sử dụng đồng bộ tự động khi bạn muốn đồng bộ chạy liên tục theo các khoảng thời gian đều đặn: 
import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  interval: 60, // Sync every 60 seconds
  database: 'mongodb',
  databaseURI: process.env.MONGODB_URI, // e.g., 'mongodb://localhost:27017'
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode' // or 'live_mode'
  }
});

// Initialize connection
await syncDodoPayments.init();

// Start the sync loop
syncDodoPayments.start();
Tùy chọn interval là bắt buộc khi sử dụng .start() cho đồng bộ tự động. Đồng bộ sẽ chạy liên tục theo khoảng thời gian đã chỉ định cho đến khi tiến trình dừng lại.

​
Đồng bộ thủ công

Sử dụng đồng bộ thủ công khi bạn muốn kích hoạt các hoạt động đồng bộ theo yêu cầu (ví dụ: từ một cron job hoặc điểm cuối API): 
import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  database: 'mongodb',
  databaseURI: process.env.MONGODB_URI,
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode'
  }
});

// Initialize connection
await syncDodoPayments.init();

// Trigger a single sync operation
await syncDodoPayments.run();
Khi sử dụng đồng bộ thủ công, tùy chọn interval không bắt buộc. Bạn có thể gọi .run() bất cứ khi nào cần thực hiện đồng bộ.

​
Ví dụ về PostgreSQL

Here’s how to use dodo-sync with PostgreSQL: 
import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  interval: 60,
  database: 'postgres',
  databaseURI: process.env.POSTGRES_URI, // e.g., 'postgresql://user:password@localhost:5432/mydb'
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode'
  }
});

await syncDodoPayments.init();
syncDodoPayments.start();

​
Ví dụ về MySQL

Here’s how to use dodo-sync with MySQL: 
import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  interval: 60,
  database: 'mysql',
  databaseURI: process.env.MYSQL_URI, // e.g., 'mysql://user:password@localhost:3306/mydb'
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode'
  }
});

await syncDodoPayments.init();
syncDodoPayments.start();

​
Ví dụ về ClickHouse

Here’s how to use dodo-sync with ClickHouse: 
import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  interval: 60,
  database: 'clickhouse',
  databaseURI: process.env.CLICKHOUSE_URI, // e.g., 'http://localhost:8123'
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode'
  }
});

await syncDodoPayments.init();
syncDodoPayments.start();

​
Tùy chọn Constructor

​
database
string
bắt buộc
Tên cơ sở dữ liệu cần sử dụng. Các giá trị hỗ trợ: "mongodb", "postgres", "mysql", hoặc "clickhouse".
​
databaseURI
string
bắt buộc
Chuỗi kết nối cho cơ sở dữ liệu của bạn:
  • MongoDB: mongodb://localhost:27017 hoặc mongodb+srv://...
  • PostgreSQL: postgresql://user:password@localhost:5432/mydb
  • MySQL: mysql://user:password@localhost:3306/mydb
  • ClickHouse: http://localhost:8123
​
scopes
string[]
bắt buộc
Mảng các thực thể cần đồng bộ. Các tùy chọn khả dụng: "licences", "payments", "customers", "subscriptions". Bạn có thể kết hợp bất kỳ tổ hợp nào trong số này.
​
dodoPaymentsOptions
object
bắt buộc
Cấu hình API Dodo Payments cho xác thực và lựa chọn môi trường. Xem TypeScript SDK types để biết đầy đủ tùy chọn.Các thuộc tính bắt buộc:
  • bearerToken: Khóa API Dodo Payments của bạn
  • environment: Hoặc "test_mode" hoặc "live_mode"
​
interval
number
Thời gian tính bằng giây giữa các lần đồng bộ tự động. Bắt buộc khi sử dụng .start() cho đồng bộ tự động. Tùy chọn khi sử dụng .run() cho đồng bộ thủ công.
​
rateLimit
number
Số lượng yêu cầu mỗi giây. Kiểm soát tốc độ mà bộ máy đồng bộ gửi yêu cầu API để tránh làm quá tải API Dodo Payments.

​
Thông tin quan trọng

MongoDB: Một cơ sở dữ liệu tên dodopayments_sync sẽ được tạo tự động trên máy chủ cơ sở dữ liệu của bạn. Tất cả dữ liệu đồng bộ sẽ được lưu ở đó. Tên cơ sở dữ liệu này hiện đang cố định và không thể thay đổi.PostgreSQL: Các bảng (Subscriptions, Payments, Licenses, Customers) sẽ được tạo trong cơ sở dữ liệu được chỉ định trong URI kết nối của bạn. Dữ liệu được lưu dưới dạng JSONB.MySQL: Các bảng (Subscriptions, Payments, Licenses, Customers) sẽ được tạo trong cơ sở dữ liệu được chỉ định trong URI kết nối của bạn. Dữ liệu được lưu dưới dạng JSON.ClickHouse: Các bảng (Subscriptions, Payments, Licenses, Customers) sẽ được tạo bằng bộ máy ReplacingMergeTree. Khi truy vấn, hãy sử dụng từ khóa FINAL để đảm bảo kết quả được loại bỏ trùng lặp.
Bộ máy đồng bộ theo dõi các thay đổi và chỉ đồng bộ các bản ghi mới hoặc đã được cập nhật, giúp các lần đồng bộ tiếp theo hiệu quả ngay cả với khối lượng dữ liệu lớn.

​
Tài nguyên bổ sung

GitHub Repository

Xem mã nguồn, báo cáo lỗi hoặc đóng góp cải tiến

npm Package

Xem chi tiết gói và hướng dẫn cài đặt