Quản lý tài nguyên Dodo Payments của bạn, tạo phiên thanh toán và kiểm tra webhook trực tiếp từ terminal. Được thiết kế cho các nhà phát triển ưa thích giao diện dòng lệnh.
Cài đặt
npm install -g dodopayments-cli
Cài đặt thủ công
- Tải bản phát hành mới nhất từ GitHub Releases cho hệ thống của bạn
- Giải nén và đổi tên binary thành
dodo
- Di chuyển đến một thư mục trong PATH của bạn:
sudo mv ./dodo /usr/local/bin/
Xác thực
Trước khi sử dụng CLI, hãy xác thực bằng khóa API của bạn:
Điều này sẽ:
- Mở trình duyệt đến trang Khóa API Dodo Payments
- Yêu cầu bạn nhập Khóa API
- Yêu cầu bạn chọn môi trường (Chế độ Test hoặc Chế độ Live)
- Lưu thông tin xác thực cục bộ vào
~/.dodopayments/api-key
CLI hỗ trợ lưu một khóa API cho mỗi môi trường. Nếu cả khóa chế độ Test và chế độ Live được cấu hình, bạn sẽ được nhắc chọn môi trường để sử dụng cho phiên hiện tại.
Cách sử dụng
Cú pháp chung là:
dodo ‹category› ‹sub-command›
dodo không có đối số sẽ hiển thị tất cả các hạng mục hiện có. Chạy dodo <category> không có lệnh con sẽ hiển thị các lệnh con sẵn có cho danh mục đó.
Sản phẩm
Quản lý danh mục sản phẩm của bạn.
| Lệnh | Mô tả |
|---|
dodo products list | Liệt kê tất cả sản phẩm (có phân trang) |
dodo products create | Mở bảng điều khiển để tạo sản phẩm |
dodo products info | Xem chi tiết cho một sản phẩm cụ thể |
Thanh toán
Xem các giao dịch thanh toán.
| Lệnh | Mô tả |
|---|
dodo payments list | Liệt kê tất cả thanh toán (có phân trang) |
dodo payments info | Lấy thông tin về một thanh toán cụ thể |
Khách hàng
Quản lý cơ sở khách hàng của bạn.
| Lệnh | Mô tả |
|---|
dodo customers list | Liệt kê tất cả khách hàng (có phân trang) |
dodo customers create | Tạo hồ sơ khách hàng mới |
dodo customers update | Cập nhật thông tin khách hàng hiện có |
Giảm giá
Quản lý phiếu giảm giá và chiết khấu.
| Lệnh | Mô tả |
|---|
dodo discounts list | Liệt kê tất cả giảm giá (có phân trang) |
dodo discounts create | Tạo giảm giá theo phần trăm mới |
dodo discounts delete | Xóa giảm giá theo ID |
Giấy phép
Quản lý giấy phép phần mềm.
| Lệnh | Mô tả |
|---|
dodo licences list | Liệt kê tất cả khóa giấy phép (có phân trang) |
Tiện ích mở rộng
Quản lý tiện ích bổ sung sản phẩm.
| Lệnh | Mô tả |
|---|
dodo addons list | Liệt kê tất cả tiện ích (có phân trang) |
dodo addons create | Mở bảng điều khiển để tạo tiện ích |
dodo addons info | Xem chi tiết cho một tiện ích cụ thể |
Hoàn tiền
Xem thông tin hoàn tiền.
| Lệnh | Mô tả |
|---|
dodo refund list | Liệt kê tất cả hoàn tiền (có phân trang) |
dodo refund info | Xem chi tiết cho một hoàn tiền cụ thể |
Thanh toán
Tạo phiên thanh toán.
| Lệnh | Mô tả |
|---|
dodo checkout new | Tạo phiên thanh toán mới và lấy URL thanh toán |
Kiểm tra Webhook
CLI bao gồm hai công cụ mạnh mẽ để kiểm tra webhook trong quá trình phát triển: một listener chuyển tiếp webhook thử nghiệm trực tiếp đến máy chủ cục bộ của bạn, và một trigger gửi các payload webhook giả đến bất kỳ endpoint nào.
Lắng nghe Webhook
Chuyển tiếp webhook từ Dodo Payments trực tiếp tới máy chủ phát triển cục bộ của bạn theo thời gian thực.
Enter your local endpoint URL
Cung cấp URL cục bộ nơi bạn muốn nhận webhook (ví dụ: http://localhost:3000/webhook).
Automatic setup
CLI tự động tạo một endpoint webhook trên tài khoản Dodo Payments của bạn nếu chưa có, sau đó mở kết nối WebSocket để nhận sự kiện theo thời gian thực.
Receive and forward
Khi một sự kiện webhook xảy ra (từ một thanh toán thử nghiệm, thay đổi đăng ký, v.v.), CLI sẽ nhận, ghi lại loại sự kiện và chuyển tiếp toàn bộ yêu cầu với tiêu đề và nội dung đến endpoint cục bộ của bạn. Phản hồi từ endpoint cũng được ghi lại và gửi lại.
Bộ lắng nghe webhook chỉ hoạt động với khóa API chế độ thử nghiệm. Hãy chắc chắn bạn đang đăng nhập với khóa chế độ thử nghiệm trước khi sử dụng dodo wh listen.
Bộ lắng nghe giữ nguyên các tiêu đề webhook gốc (webhook-id, webhook-signature, webhook-timestamp) khi chuyển tiếp tới endpoint cục bộ của bạn, giúp bạn kiểm tra logic xác minh chữ ký.
Kích hoạt Webhook kiểm tra
Gửi payload webhook giả đến bất kỳ endpoint nào để kiểm tra nhanh mà không cần tạo giao dịch thật.
Điều này hướng dẫn bạn qua:
- Thiết lập endpoint URL đích
- Tùy chọn cấu hình Business ID, Product ID, và Metadata
- Chọn một sự kiện cụ thể để kích hoạt từ menu tương tác
- Gửi payload giả và xem phản hồi
Sau mỗi sự kiện, bạn có thể chọn sự kiện khác để kích hoạt hoặc thoát — giúp bạn dễ dàng kiểm tra nhiều bộ xử lý sự kiện trong một phiên.
Công cụ trigger gửi payload giả mà không có chữ ký webhook. Vô hiệu hóa việc xác minh chữ ký webhook trong quá trình thử nghiệm bằng cách sử dụng unsafe_unwrap() thay vì unwrap() trong trình xử lý webhook của bạn.
Các sự kiện Webhook được hỗ trợ
| Danh mục | Sự kiện |
|---|
| Subscription | subscription.active, subscription.updated, subscription.on_hold, subscription.renewed, subscription.plan_changed, subscription.cancelled, subscription.failed, subscription.expired |
| Payment | payment.success, payment.failed, payment.processing, payment.cancelled |
| Refund | refund.success, refund.failed |
| Dispute | dispute.opened, dispute.expired, dispute.accepted, dispute.cancelled, dispute.challenged, dispute.won, dispute.lost |
| License | licence.created |
Biến môi trường
| Biến | Mô tả |
|---|
DODO_WH_TEST_SERVER_URL | Ghi đè URL máy chủ chuyển tiếp webhook mặc định được sử dụng bởi dodo wh listen |
Tài nguyên
Hỗ trợ
