API (Application programming interface) là một tập các quy tắc và cơ chế mà theo đó một ứng dụng hay một thành phần sẽ tương tác với một ứng dụng hay một thành phần khác. API có thể cung cấp khả năng truy xuất đến một tập các hàm. Thực tế, API có thể hiểu đơn giản là các hàm hay thủ tục thơng thường có thể viết
Tên Use Case Truyền nhận dữ liệu
trên nhiều ngơn ngữ lập trình khác nhau.
Hệ thống IVAS sẽ quy định trong định nghĩa API sử dụng các phương thức GET/POST khơng có phương thức DELETE. Điều này có thể hiểu khi ngân hàng thực hiện gọi một API thì các API này chỉ có thể lấy dữ liệu như dữ liệu về thơng tin người nộp thuế, dữ liệu về kì thuế, loại thuế.... được cho phép. Đồng thời insert chứng từ, biên lai nộp thuế vào cơ sở dữ liệu trong hệ thống IVAS. Trong các phương thức của API sẽ khơng có phương thức DELETE có nghĩa là khơng có thể thực hiện xóa được dữ liệu trong hệ thống IVAS.
Trong CSDL mỗi API được gọi thực hiện các câu lệnh truy vấn đến bảng trong CSDL để lấy các dữ liệu mong muốn từ hệ thống IVAS trong cơ sở dữ liệu đặt trên Oracle database.
Mỗi ngân hàng sẽ được cấp một user name và password riêng khi thực hiện gọi API. Nếu như mỗi user đều có quyền truy cập khơng giới hạn vào CSDL của hệ thống sẽ không đảm bảo sự an toàn và bảo mật dữ liệu. Vì vậy, mỗi một user sẽ được cấp quyền cho phép gọi tới những API mà được phép.
Để gửi request API, hệ thống IVAS đã sử dụng JSON để định dạng dữ liệu (JSON là định dạng lưu trữ thơng tin có cấu trúc và chủ yếu được sử dụng để truyền dữ liệu giữa server và client giúp 2 hệ thống hoàn tồn có thể hiểu được). Khi bên ngân hàng gửi một request tới server của hệ thống IVAS thì ngay lập tức server của IVAS sẽ trả lại một response về bên ngân hàng.
Dữ liệu để gửi request được viết theo định dạng file JSON. Dữ liệu để trả về response sẽ được gửi về cũng theo định dạng file JSON. Cú pháp của JSON bao gồm hai phần là “key” và “value.”
Các thuộc tính trong file JSON sẽ được hệ thống IVAS quy định với bên ngân hàng. Sau khi gửi Request và thực hiện hiện các bước kiểm tra Response, dữ liệu trả về có thể là dữ liệu mong muốn hoặc có thể là một thơng báo về lỗi dưới dạng mã lỗi.
2.2.3 Sơ đồ hoạt động use case truyền nhận dữ liệu
Biểu đồ hoạt động miêu tả use case truyền nhận dữ liệu được mơ tả như hình dưới đây: