API Key

Trang này hướng dẫn quản trị viên đại lý khởi tạo và quản lý các khóa API Key dùng để xác thực và cấp quyền truy cập dữ liệu đại lý qua hệ thống Public API của Ferry.vn.

Lập trình viên tích hợp hệ thống có thể tham khảo chi tiết cơ chế xác thực và cách truyền mã khóa tại tài liệu Xác thực API.

Mở trang: menu Cài Đặt ở thanh bên trái → chọn tab API Keys.

Lưu ý an toàn khi quản lý API Key

• Chức năng này chỉ dành cho quản trị viên nắm rõ cách vận hành và tích hợp REST API.
• Việc bảo mật các API Key thuộc hoàn toàn trách nhiệm của đại lý.
• Nếu phát hiện khóa API Key bị rò rỉ (leak), hãy xóa khóa đó ngay lập tức để ngăn chặn truy cập trái phép.

Tạo mới API Key

Màn hình quản lý danh sách API Key của đại lý

1. Nhấn nút + Thêm mới ở góc trên bên phải màn hình danh sách khóa.

   

   Nút Thêm mới ở góc trên bên phải danh sách khóa

2. Hộp thoại Tạo API Key xuất hiện. Nhập tên phân biệt vào ô Tên Key (nên đặt tên theo hệ thống hoặc mục đích tích hợp cụ thể, ví dụ: Website Bán Vé hoặc Phần Mềm Kế Toán).

   

   Hộp thoại nhập tên định danh cho API Key mới

3. Nhấn Tạo mới để hệ thống sinh khóa.

4. Cửa sổ Lưu API Key hiển thị mã khóa vừa tạo. Nhấn biểu tượng sao chép bên cạnh mã khóa để lưu lại vào kho lưu trữ an toàn.

   

   Hộp thoại hiển thị API Key mới cùng cảnh báo bảo mật

API Key chỉ hiển thị một lần duy nhất

Theo tiêu chuẩn bảo mật, tất cả API Key sau khi tạo ra đều được băm (hash) một chiều trong cơ sở dữ liệu. Hệ thống không thể hiển thị lại khóa này sau khi bạn đóng cửa sổ. Nếu làm mất mã khóa, bạn cần xóa khóa cũ và tiến hành tạo khóa mới.