Giới thiệu
Metadata cho phép bạn lưu trữ thông tin bổ sung, có cấu trúc về các đối tượng của bạn trong Dodo Payments. Bạn có thể gán metadata cho hầu hết các đối tượng Dodo Payments, bao gồm thanh toán, đăng ký, và nhiều hơn nữa.Tổng quan
- Khóa metadata có thể dài tối đa 40 ký tự
- Giá trị metadata có thể là chuỗi, số nguyên, số hoặc boolean; chuỗi có thể dài tối đa 500 ký tự
- Không chấp nhận đối tượng, mảng và
nulllàm giá trị metadata - Mỗi đối tượng có thể có tối đa 50 cặp khóa-giá trị metadata
- Khóa chỉ nên chứa các ký tự chữ và số, dấu gạch ngang và dấu gạch dưới
- Không thể tìm kiếm metadata bằng API của chúng tôi, nhưng metadata được trả về trong API responses và webhooks
Trường hợp sử dụng
Metadata hữu ích cho:- Lưu trữ ID hoặc tham chiếu bên ngoài
- Thêm chú thích nội bộ
- Liên kết các đối tượng Dodo Payments với hệ thống của bạn
- Phân loại giao dịch
- Thêm thuộc tính tùy chỉnh cho báo cáo
Thêm Metadata
Bạn có thể thêm metadata khi tạo hoặc cập nhật các đối tượng thông qua API. Đối với sản phẩm, bạn cũng có tùy chọn thêm metadata trực tiếp từ giao diện bảng điều khiển.Qua API
Qua Giao diện Bảng điều khiển (Chỉ Sản phẩm)
Đối với sản phẩm, bạn cũng có thể thêm metadata trực tiếp từ bảng điều khiển Dodo Payments khi tạo hoặc chỉnh sửa một sản phẩm. Phần metadata cho phép bạn dễ dàng thêm các cặp khóa-giá trị tùy chỉnh mà không cần viết mã.
Lấy Metadata
Metadata được bao gồm trong các phản hồi API khi lấy các đối tượng:Việc truy xuất một checkout session (
GET /checkouts/{id}) không trả về metadata. Phản hồi trạng thái của session chỉ chứa id, created_at, payment_id, payment_status, customer_email và customer_name. Thay vào đó, hãy đọc metadata bạn đã đính kèm khi tạo session từ payment tương ứng, bằng cách sử dụng payment_id được endpoint đó trả về.Tìm kiếm và lọc
Mặc dù không thể tìm kiếm metadata trực tiếp thông qua API của chúng tôi, bạn có thể:- Lưu các mã định danh quan trọng trong metadata
- Truy xuất các đối tượng bằng ID chính của chúng
- Lọc kết quả trong code ứng dụng của bạn
Các phương pháp hay nhất
Nên:
- Sử dụng quy ước đặt tên nhất quán cho các khóa metadata
- Tài liệu hóa schema metadata nội bộ
- Giữ cho các giá trị ngắn gọn và có ý nghĩa
- Chỉ sử dụng metadata cho dữ liệu tĩnh
- Cân nhắc sử dụng tiền tố cho các hệ thống khác nhau (ví dụ:
crm_id,inventory_sku)
Không nên:
- Lưu dữ liệu nhạy cảm trong metadata
- Sử dụng metadata cho các giá trị thay đổi thường xuyên
- Phụ thuộc vào metadata cho logic nghiệp vụ quan trọng
- Lưu thông tin trùng lặp đã có ở nơi khác trong đối tượng
- Sử dụng ký tự đặc biệt trong khóa metadata