API dữ liệu không gian: kết nối nguồn dùng chung, hạn chế sao chép
Các nội dung cần làm rõ về nguồn chính thức, quyền truy cập, cấu trúc và phiên bản trước khi cung cấp dữ liệu không gian qua API.
Khi một hệ thống gửi tệp dữ liệu cho hệ thống khác, thông tin về người tạo, thời điểm cập nhật và phiên bản hiện hành rất dễ bị tách rời. API có thể hạn chế việc sao chép, nhưng không thể khắc phục một nguồn dữ liệu thiếu người chịu trách nhiệm hoặc chưa có quy tắc quản lý rõ ràng.
API là một thỏa thuận giữa các hệ thống
Trước khi mở API, cần xác định nguồn dữ liệu chuẩn, trường nào được chia sẻ, ai được truy cập, giới hạn truy vấn và cách ghi nhận thay đổi. Một API phơi bày dữ liệu sai hoặc nhạy cảm chỉ làm rủi ro lan nhanh hơn.
Bắt đầu từ một luồng có người dùng thật
Nên bắt đầu từ một nhu cầu cụ thể: ứng dụng nghiệp vụ cần tra cứu tài sản, bảng điều hành cần tổng hợp theo khu vực hoặc ứng dụng hiện trường cần gửi dữ liệu cập nhật. Một phạm vi nhỏ giúp kiểm tra cấu trúc dữ liệu, phân quyền, hiệu năng và cách xử lý lỗi trước khi mở rộng.
Chuẩn mở giúp các hệ thống nói cùng một ngôn ngữ
OGC API - Features là bộ tiêu chuẩn mở để cung cấp và truy vấn đối tượng không gian trên web theo một giao diện thống nhất. Trang chính thức của OGC API - Features công bố trạng thái của từng phần: các phần lõi, hệ quy chiếu, lọc và lược đồ đã thành tiêu chuẩn; phần tạo, thay thế, cập nhật và xóa vẫn cần kiểm tra trạng thái trước khi áp dụng.
Tiêu chuẩn không thay thế việc thiết kế API cho nhu cầu cụ thể. Hệ thống vẫn phải thống nhất hệ tọa độ, định dạng ngày, đơn vị, mã đối tượng, phân trang, phân quyền và cách thông báo lỗi.
Thiết kế từ trường hợp sử dụng
API nên cung cấp đúng phần dữ liệu cần dùng, không phơi bày nguyên trạng cấu trúc cơ sở dữ liệu nội bộ. Một ứng dụng nghiệp vụ, một bảng điều hành và một thiết bị hiện trường có thể cần các trường, bộ lọc, phép tổng hợp và quyền cập nhật khác nhau. Tài liệu API cần có ví dụ yêu cầu, dữ liệu trả về, lỗi thường gặp và quy tắc phiên bản.
Quản lý thay đổi ngay từ đầu
Khi API đã được nhiều hệ thống sử dụng, việc đổi tên trường hoặc thay kiểu dữ liệu có thể gây ảnh hưởng dây chuyền. Cần có nhật ký thay đổi, cách thông báo, thời gian chuyển tiếp và cơ chế theo dõi lỗi, lưu lượng cùng thời gian phản hồi. Bài Từ tệp rời đến dữ liệu có người chịu trách nhiệm giải thích phần vận hành phía sau kết nối kỹ thuật.
Tài liệu API cần mô tả các điểm truy cập, ví dụ truy vấn, quy tắc lỗi, giới hạn sử dụng và đầu mối xử lý khi dữ liệu sai. Chất lượng API không nằm ở số lượng điểm truy cập mà ở khả năng cung cấp đúng dữ liệu, đúng quyền và hạn chế phát sinh bản sao ngoài kiểm soát.
Tài liệu tham khảo
- OGC API - Features: trạng thái các phần của chuẩn và tài liệu kỹ thuật chính thức.
- OGC API - Features for developers: giải thích collection, item, truy vấn và khả năng tương tác bằng ví dụ.
- W3C/OGC — Spatial Data on the Web Best Practices: định danh bền vững, metadata, phiên bản và API thuận tiện cho người dùng.
Lưu ý: OGC API - Features Part 1 tập trung vào truy cập đọc; các khả năng tạo, sửa và xóa nằm ở phần mở rộng/dự thảo và cần kiểm tra trạng thái trước khi chọn làm căn cứ triển khai.