Tạo và cập nhật API Key
Hướng dẫn tạo, xem và cập nhật API Key dùng cho tích hợp hệ thống.
API Key dùng để cấp quyền cho hệ thống bên ngoài kết nối với Cropany. Người quản trị có thể tạo key mới, xem key đã tạo, giới hạn IP được phép gọi và đổi secret khi cần.
Vị trí thao tác
Vào trang API Key trong nhóm cài đặt nâng cao. Từ danh sách, nhấn Thêm mới để tạo key hoặc nhấn nút sửa trên một dòng để cập nhật key đã có.
Giao diện tổng thể
Khi tạo mới, form chỉ yêu cầu thông tin cơ bản. Sau khi lưu và mở lại bản ghi, hệ thống sẽ hiển thị thêm API Key, API Secret, trạng thái và nút đổi secret.
Thông tin cần nhập
| Trường | Bắt buộc | Ghi chú |
|---|---|---|
| Tên | Có | Đặt tên dễ nhận biết, ví dụ tên ứng dụng hoặc đối tác sử dụng key. |
| Mô tả hoặc ghi chú | Không | Ghi rõ mục đích sử dụng để tiện quản lý về sau. |
| Danh sách IP được phép | Không | Nhập từng địa chỉ IP được phép sử dụng key. Nếu để trống, key không bị giới hạn theo IP trên giao diện này. |
| API Key | Không nhập tay | Hệ thống tự sinh và chỉ hiển thị khi sửa bản ghi đã tạo. |
| API Secret | Không nhập tay | Hệ thống tự sinh và chỉ hiển thị khi sửa bản ghi đã tạo. |
| Trạng thái | Không | Dùng để bật hoặc tạm ngưng key. |
Đổi secret (chỉ khi đang sửa)
Khi mở key đã tạo, nhấn Đổi secret để tạo API Secret mới. Secret mới sẽ hiển thị ngay trên form để bạn sao chép và cập nhật cho hệ thống đang tích hợp.
Sau khi đổi secret, secret cũ không nên tiếp tục được sử dụng. Hãy cập nhật lại thông tin ở hệ thống kết nối để tránh gián đoạn tích hợp.
Validation
- Tên key là bắt buộc.
- Danh sách IP cần nhập đúng định dạng địa chỉ IP.
- Nếu lưu không thành công, đọc thông báo lỗi trên màn hình và điều chỉnh dữ liệu tương ứng.
Kết quả sau khi lưu
- Khi tạo mới thành công, danh sách API Key được cập nhật.
- Khi sửa thành công, thông tin key được lưu lại.
- Khi đổi secret thành công, form vẫn mở để bạn kịp sao chép secret mới.
Lưu ý - Lỗi thường gặp
- Không thấy API Key hoặc API Secret khi tạo mới: đây là hành vi bình thường. Hệ thống chỉ hiển thị sau khi key được tạo.
- Không thấy nút đổi secret khi tạo mới: hãy lưu key trước, sau đó mở lại để đổi secret nếu cần.
- Trạng thái không có lựa chọn Bị khóa: trạng thái khóa do hệ thống xử lý, người dùng không tự đặt thủ công từ form này.
- Tích hợp báo lỗi sau khi đổi secret: kiểm tra lại secret mới đã được cập nhật đúng ở hệ thống kết nối.
- IP bị từ chối: kiểm tra địa chỉ IP đang gọi có nằm trong danh sách được phép không.
Ai được xem và chỉnh?
- Cần quyền cài đặt nâng cao để tạo, sửa hoặc đổi secret API Key.
- Người không có quyền thao tác có thể không thấy các nút tạo, sửa hoặc xoá.