Xử lý chữ ký API

Chữ ký API là các cơ chế bảo mật dùng để xác minh tính xác thực và tính toàn vẹn của yêu cầu. Hướng dẫn này trình bày cách tự động hóa việc tạo chữ ký trong Apidog, loại bỏ nhu cầu truy xuất chữ ký theo cách thủ công cho từng yêu cầu.

Chiến lược tự động hóa chữ ký

Thay vì truy cập thủ công vào một endpoint chữ ký trước mỗi yêu cầu, hãy sử dụng khả năng viết script của Apidog để:

Tạo một script công khai triển khai logic chữ ký

Tự động tạo chữ ký bằng các tham số yêu cầu

Gắn chữ ký vào yêu cầu thông qua script hoặc biến môi trường

Tham chiếu script công khai trong các bộ tiền xử lý API

Phương pháp triển khai

Phương pháp 1: Sửa đổi script trực tiếp

Thêm tham số chữ ký và sửa đổi thông tin yêu cầu trực tiếp thông qua script mà không sử dụng biến môi trường.

Ưu điểm:

Không cần quản lý biến môi trường

Cập nhật tham số tức thì

Cấu hình đơn giản hơn

Phương pháp 2: Biến môi trường

Tạo chữ ký và ghi chữ ký đó vào một biến môi trường, sau đó tham chiếu biến trong các tham số API.

Ưu điểm:

Có thể tái sử dụng trên nhiều yêu cầu

Dễ gỡ lỗi và giám sát hơn

Quản lý chữ ký tập trung

Phương pháp 3: Chương trình bên ngoài

Đối với các chữ ký được triển khai bằng ngôn ngữ khác, hãy sử dụng phương thức dog.execute để gọi các chương trình bên ngoài.

Ví dụ: Chữ ký dựa trên MD5

Quy tắc tạo chữ ký

Bước 1: Xây dựng chuỗi tham số

Thu thập tất cả các tham số không rỗng vào tập hợp M

Sắp xếp tham số theo mã ASCII theo thứ tự tăng dần (thứ tự từ điển)

Nối các tham số theo định dạng key-value URL: key1=value1&key2=value2...

Kết quả: stringA

Quy tắc quan trọng:

Sắp xếp tên tham số theo mã ASCII theo thứ tự tăng dần

Các giá trị tham số rỗng bị loại khỏi chữ ký

Tên tham số phân biệt chữ hoa chữ thường

Bản thân tham số sign bị loại khỏi chữ ký

Bước 2: Tạo chữ ký

Nối key vào cuối stringA để có stringSignTemp

Áp dụng thuật toán MD5 cho stringSignTemp

Chuyển kết quả sang chữ hoa để có signValue

Triển khai script công khai

Ví dụ: Chữ ký API dịch thuật

Quy tắc tạo chữ ký

Bước 1: Nối chuỗi

Nối các giá trị sau theo thứ tự:

appid: ID ứng dụng

q: Văn bản cần dịch (mã hóa UTF-8)

salt: Số ngẫu nhiên

key: Key do nền tảng cấp (có sẵn trong bảng điều khiển quản lý)

Kết quả: appid + q + salt + key

Bước 2: Tạo chữ ký

Áp dụng thuật toán MD5 cho chuỗi đã nối để có chữ ký chữ thường 32 bit.

Lưu ý quan trọng:

Văn bản cần dịch (q) phải được mã hóa UTF-8

Khi nối appid+q+salt+key, KHÔNG áp dụng mã hóa URL cho q

Sau khi chữ ký được tạo, hãy áp dụng mã hóa URL cho q trước khi gửi yêu cầu HTTP

Ví dụ yêu cầu

Triển khai script công khai

Thực hành tốt nhất

Thực hành	Mô tả
Sử dụng biến môi trường	Lưu trữ các key nhạy cảm trong biến môi trường, không lưu trong script
Xác thực tham số	Kiểm tra các tham số bắt buộc trước khi tạo chữ ký
Ghi log để gỡ lỗi	Sử dụng `console.log()` để gỡ lỗi các vấn đề khi tạo chữ ký
Xử lý các trường hợp biên	Tính đến các giá trị rỗng, ký tự đặc biệt và mã hóa
Tập trung hóa logic	Sử dụng script công khai để tránh sao chép logic chữ ký
Kiểm thử kỹ lưỡng	Xác minh việc tạo chữ ký bằng các trường hợp kiểm thử đã biết

Xử lý chữ ký API

Chiến lược tự động hóa chữ ký#

Phương pháp triển khai#

Phương pháp 1: Sửa đổi script trực tiếp#

Phương pháp 2: Biến môi trường#

Phương pháp 3: Chương trình bên ngoài#

Ví dụ: Chữ ký dựa trên MD5#

Quy tắc tạo chữ ký#

Triển khai script công khai#

Ví dụ: Chữ ký API dịch thuật#

Quy tắc tạo chữ ký#

Ví dụ yêu cầu#

Triển khai script công khai#

Thực hành tốt nhất#

Chiến lược tự động hóa chữ ký

Phương pháp triển khai

Phương pháp 1: Sửa đổi script trực tiếp

Phương pháp 2: Biến môi trường

Phương pháp 3: Chương trình bên ngoài

Ví dụ: Chữ ký dựa trên MD5

Quy tắc tạo chữ ký

Triển khai script công khai

Ví dụ: Chữ ký API dịch thuật

Quy tắc tạo chữ ký

Ví dụ yêu cầu

Triển khai script công khai

Thực hành tốt nhất