API và các thuật ngữ quan trọng BA nên biết! – Phần 2

Để các bạn BA có thêm nhiều kiến thức về API, hôm nay BAC sẽ tiếp tục gửi đến các bạn bài viết về những thuật ngữ cực hữu ích đối với BA. Hãy theo dõi ngay nhé!

Nếu các bạn chưa xem qua phần 1, hãy xem ngay:

• API và các thuật ngữ quan trọng BA nên biết! – Phần 1

1. HTTP Methods

HTTP Methods là các phương thức/hành động tương tác với resource. Một số phương thức phổ biến:

• POST: Có nghĩa là tạo mới, tương ứng với . Ví dụ bạn muốn thêm một sản phẩm và trang web, bạn sẽ thêm những thông tin như: Tên, hình ảnh, giá cả, mô tả.
• GET: Đây là phương thức rất phổ biến dùng để đọc hoặc truy xuất dữ liệu. Ví dụ khi cần truy xuất các bài viết từ Facebook, bạn sẽ sử dụng phương thức GET.

• PUT: PUT dùng để thay thế hoặc cập nhật các thông tin của resource.
• DELETE: DELETE giúp client xóa bỏ các thông tin.

Các phương thức rất quan trọng và ảnh hưởng lớn đến dữ liệu gốc nên khi sử dụng chúng ta cần cẩn trọng để tránh gây ra sai sót.

2. Endpoints

Tương tự khi cần đến nhà một người bạn chúng ta cần biết địa chỉ nhà của họ, khi truy xuất thông tin ta cũng cần biết “địa chỉ” của dữ liệu. 

Ví dụ, để lấy thông tin của một album trên Spotify ta cần cú pháp GET v1/albums/{id}/tracks.

Trong đó:

• HTTP Method: GET.
• Endpoint: /v1/albums/{id}/tracks.
• Mục đích: để lấy danh sách các track trong một album cụ thể. Có thể đưa thêm các tham số để giới hạn thông tin trả về.

3. API Documentation

Để các bên liên quan có thể hiểu các thông tin liên quan như quyền hạn, thông tin, cách sử dụng thì API Documentation chính là đảm nhiệm nhiệm vụ đó. Trong tài liệu API sẽ có đầy đủ các thông tin như:

• Authentication Instructions: Trong đây sẽ hướng dẫn cách bạn kết nối với API. Ví dụ cụ thể Authentication Instructions của Twitter xem ngay TẠI ĐÂY.

• API Endpoints: Là xem các “địa chỉ” tham chiếu hiện tại của API. Bạn có thể tham khảo thêm về các Endpoints của Twitter TẠI ĐÂY.

• Resources: Các tài nguyên nào có sẵn và bạn có thể truy cập.

• Request Format: Là định dạng quy định cho các yêu cầu.

• Response Format:Là định dạng quy định cho các phản hồi

• Response Codes: Các loại mã bao gồm thành công và tình huống lỗi. Chúng ta vẫn rất thường gặp 404 nhưng vẫn chưa biết chúng là gì, cùng xem chi tiết hơn ở phần dưới nhé!

4. API Calls

API calls là toàn bộ quá trình gửi request và nhận response. Để hiểu rõ hơn chúng ta cần thực hiện qua một số bước sau:

• Tìm URI.
• Xác định HTTP Methods.
• Thêm vào Header (sẽ giải thích ở phần 7).
• Thêm mã API hoặc mã truy cập.
• Chờ đợi phản hồi.

5. Payload

Payload bao gồm các thông tin trong response tuy nhiên ở đây payload đề cập đến chủ yếu thông tin “quan trọng” mà khách hàng muốn nhận được. Ví dụ, trong một response sẽ bao gồm nhiều nội dung nhưng Welcome, world! chính là Payload.

Các bạn lập trình viên rất thường sử dụng thuật ngữ này, vậy nên là một BA, hãy thể hiện sự chuyên nghiệp của mình hiểu đúng và dùng đúng khi lập trình viên hoặc khách hàng đề cập nhé!

6. Response Codes

Danh sách mã rất nhiều và đại diện từng đầu mã như sau:

• Các mã bắt đầu bằng 1xx: Phản hồi thông tin – yêu cầu đã được nhận, tiếp tục quá trình.
• Các mã bắt đầu bằng 2xx: Thành công – yêu cầu đã được nhận, hiểu và chấp nhận thành công chuyển hướng.
• Các mã bắt đầu bằng 3xx: Chuyển hướng – Cần thực hiện thêm hành động để hoàn thành yêu cầu.
• Các mã bắt đầu bằng 4xx: Lỗi máy khách – Yêu cầu chứa cú pháp sai hoặc không thể đáp ứng.
• Các mã bắt đầu bằng 5xx: Lỗi máy chủ – Máy chủ không thực hiện được yêu cầu mặc dù hợp lệ.

7. Headers

Một số thông tin trong headers mà chúng ta thường gặp là:

• Authorisation: Phần này dùng để xác thực cho phép Client truy cập vào Server.
• Content-type: Xác định kiểu representation. Trong hình minh họa chúng ta có thể thấy là JSON.
• Date: Là thời gian của request, response.

8. Authentication

Mặc dù là mã nguồn mở nhưng API vẫn cần độ bảo mật và an toàn nhất định, vậy nên việc xác thực người dùng là rất quan trọng. Ở đây có hai thuật ngữ cần phân biệt là Authentication và Authorisation:

• Authentication: Là xác định Client là ai, có đúng những người mà Server cấp phép hay không. Thường trong API sẽ dùng các Key và Token để xác thực Client. Bạn có thể tham khảo ví dụ hình minh họa.

• Authorisation: Sau khi xác minh đúng Client rồi thì cũng cần xác thực thêm thông tin về quyền hạn của Client để cung cấp cho chính xác các thông tin.

9. Polling vs. Webhook

Polling và Webhook có chức năng cơ bản là tương đồng nhau là cập nhật các thông tin mới. Tuy nhiên khác nhau ở một điểm:

• Polling là Client chủ động liên hệ với phía Server để cập nhật các thông tin mới. Sau đó Server sẽ phản hồi lại cho Client. 
• Webhook là Server tự cập nhật dữ liệu ngay khi có những thay đổi.

Nguồn tham khảo:

Bài viết API 101 – tác giả Thai Son

Nhu cầu đào tạo doanh nghiệp