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
- Các khóa siêu dữ liệu có thể dài tới 40 ký tự
- Các giá trị siêu dữ liệu có thể là chuỗi, số hoặc boolean; chuỗi có thể dài tới 500 ký tự
- Các đối tượng, mảng và
null không được chấp nhận làm giá trị siêu dữ liệu
- Bạn có thể có tối đa 50 cặp khóa-giá trị siêu dữ liệu mỗi đối tượng
- 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
- Siêu dữ liệu không thể tìm kiếm được bằng API của chúng tôi nhưng được trả về trong các phản hồi API và webhook
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
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ã.
Việc sử dụng giao diện bảng điều khiển cho metadata sản phẩm đặc biệt hữu ích đối với các thành viên không chuyên về kỹ thuật cần quản lý thông tin và danh mục sản phẩm.
Metadata được bao gồm trong các phản hồi API khi lấy các đối tượng:
Tìm kiếm và Lọc
Mặc dù metadata không thể tìm kiếm trực tiếp qua API của chúng tôi, bạn có thể:
- Lưu trữ các định danh quan trọng trong metadata
- Lấy các đối tượng bằng ID chính của chúng
- Lọc kết quả trong mã ứng dụng của bạn
Thực hành tốt nhất
Do:
- Sử dụng quy ước đặt tên nhất quán cho các khóa metadata
- Ghi chép sơ đồ metadata nội bộ
- Giữ giá trị ngắn và có ý nghĩa
- Chỉ sử dụng metadata cho dữ liệu tĩnh
- Cân nhắc 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 trữ dữ liệu nhạy cảm trong metadata
- Sử dụng metadata cho các giá trị thay đổi thường xuyên
- Dựa vào metadata cho logic kinh doanh quan trọng
- Lưu trữ thông tin trùng lặp có sẵn ở nơi khác trong đối tượng
- Sử dụng ký tự đặc biệt trong các khóa metadata
Các đối tượng được hỗ trợ
Metadata được hỗ trợ trên các đối tượng sau:
Metadata được bao gồm trong các sự kiện webhook, giúp dễ dàng xử lý thông báo với dữ liệu tùy chỉnh của bạn: