API thành công không đảm bảo dữ liệu đầy đủ

Kết quả API thành công chỉ cho biết một yêu cầu đã được xử lý; kết quả có thể bị giới hạn bởi số trang, phạm vi thời gian, thời gian lưu giữ và quyền. Trước khi xuất các bản ghi giao dịch, hãy làm rõ xem API trả về đơn đặt hàng, giao dịch hay thay đổi sổ cái, và xác minh phạm vi tài khoản, tài khoản phụ và sản phẩm. Trang đầu tiên mặc định không thể được coi là toàn bộ lịch sử, cũng như một mảng trống không thể được hiểu trực tiếp là một tài khoản chưa từng hoạt động.

Các phương thức phân trang phải được triển khai theo tài liệu.

Các giao diện khác nhau sử dụng thời gian, mã định danh sự kiện hoặc con trỏ trước/sau để phân trang, và việc sắp xếp và bao gồm ranh giới cũng có thể khác nhau. Lưu các tham số của mỗi yêu cầu, phạm vi phản hồi và con trỏ tiếp theo; không nên cho rằng việc thêm một giây vào thời gian sẽ ngăn chặn việc bỏ sót. Nhiều bản ghi có thể xảy ra trong cùng một mili giây; mã định danh ổn định thường phù hợp hơn cho việc liên kết so với dấu thời gian đơn lẻ, nhưng phạm vi của chúng vẫn cần được xác nhận.

Sử dụng các cửa sổ chồng chéo để xác định sự cố.

Các cửa sổ liền kề có thể chồng lấp một chút, khi đó nên thực hiện việc loại bỏ trùng lặp bằng cách sử dụng khóa sự kiện cụ thể. Điều này giúp kiểm tra ranh giới; việc loại bỏ trùng lặp đơn giản không nên che giấu các thay đổi trường. Nếu nhiều giao dịch xảy ra tại một thời điểm, việc chia cửa sổ chỉ giữ lại bản ghi đầu tiên sẽ dẫn đến việc bỏ sót. Ghi lại thời gian sớm nhất và muộn nhất, số lượng bản ghi được trả về và các thay đổi con trỏ. Dừng lại và điều tra nếu cùng một trang xuất hiện nhiều lần.

Giới hạn tốc độ và việc thử lại phải có thể khôi phục được.

Giới hạn các yêu cầu theo lô theo tốc độ chính thức. Tránh thử lại khi gặp phải giới hạn tốc độ hoặc lỗi tạm thời và tiếp tục từ con trỏ đã được xác nhận. Không thêm các quyền API không cần thiết để cải thiện tốc độ và không nâng cấp các khóa dữ liệu đọc thành các khóa có thể rút lại. Không nên ghi nhật ký các khóa và chữ ký; việc ghi lại tóm tắt yêu cầu là đủ để xác minh và các tệp nhật ký cũng nên bảo vệ thông tin liên quan đến tài khoản.

Tính đầy đủ dựa trên việc kiểm tra chéo.

So sánh số lượng giao dịch, phí và thay đổi tài sản đã xuất với báo cáo tài khoản, sao kê hàng tháng hoặc số dư đầu kỳ và cuối kỳ. Các khoản chuyển vào, chuyển ra, phần thưởng và điều chỉnh có thể đến từ các giao diện khác; hồ sơ giao dịch không thể giải thích toàn bộ số dư. Các sai lệch không giải thích được nên được đánh dấu riêng; không tạo ra giao dịch bổ sung. Nếu lịch sử đã vượt quá thời gian lưu giữ của giao diện, nên tham khảo báo cáo chính thức hoặc phiếu hỗ trợ.

Xuất các gói dữ liệu có thể kiểm toán

Lưu phiên bản tài liệu giao diện, thời gian xuất, phạm vi tài khoản, tham số phân trang, số hàng, quy tắc loại bỏ trùng lặp và danh sách ngoại lệ, đồng thời giữ lại bản sao an toàn của phản hồi gốc. Các tuyên bố về tính toàn vẹn của các công cụ bên thứ ba cũng có thể được xác minh thông qua các bản ghi này. Tài liệu này chỉ dành cho mục đích xử lý dữ liệu và không đảm bảo tính khả dụng vĩnh viễn của bất kỳ giao diện cụ thể nào, cũng như không tự động tạo ra kết luận về thuế hoặc đánh giá khả năng thanh toán của nền tảng.