Quản lý API Key
Trang API Keys cho phép bạn tạo, xem và quản lý các key mà ứng dụng của bạn sử dụng để gọi FourA API.
Xem các Key của bạn
Trang này hiển thị tất cả các key mà bạn có quyền truy cập:
- Personal keys do bạn trực tiếp tạo.
- Organization keys nếu bạn là chủ sở hữu hoặc quản trị viên tổ chức.
- Team keys được chia sẻ với bạn thông qua tư cách thành viên nhóm.
Mỗi hàng trong bảng hiển thị:
| Cột | Nội dung hiển thị |
|---|---|
| Name | Tên hiển thị và mô tả (tùy chọn) |
| Key | Tiền tố được ẩn (ví dụ: pk_live_••••••••) kèm theo nút Reveal bên cạnh |
| Owner | ME đối với personal keys, TEAM đối với org keys hoặc team-shared keys |
| IP Allowlist | Các IP bị giới hạn nếu được thiết lập, hoặc "All IPs" nếu không giới hạn |
| Expires | Ngày hết hạn nếu được thiết lập, hoặc "Never" |
| Status | Active hoặc Inactive |
| Created | Thời điểm key được tạo |
| Last Used | Thời điểm key thực hiện request cuối cùng |
Sử dụng hộp tìm kiếm để lọc theo tên hoặc mô tả, và bộ lọc trạng thái để chỉ hiển thị các key active hoặc inactive.
Tạo một Key
Nhấp vào Create Key và điền thông tin:
| Trường | Bắt buộc | Mô tả |
|---|---|---|
| Name | Có | Nhãn mô tả (ví dụ: "production-scraper" hoặc "staging-test") |
| Description | Không | Ghi chú về mục đích sử dụng của key này |
Nếu bạn thuộc về một tổ chức, bạn cũng có thể gán key cho tổ chức đó thay vì tài khoản cá nhân của mình.
Key đầy đủ chỉ được hiển thị một lần duy nhất ngay sau khi tạo trong một hộp thoại sẵn sàng để sao chép. Bạn cũng có thể xem lại sau đó thông qua tính năng Reveal (xem bên dưới) miễn là key được tạo sau khi tính năng reveal được ra mắt.
Các key sử dụng tiền tố pk_live_ và có dạng như: pk_live_a1b2c3d4e5f6.... Bạn sẽ nhận được một email xác nhận khi một key mới được tạo.
Tiết lộ một Key
Nhấp vào biểu tượng hình con mắt bên cạnh tiền tố được ẩn của key để xem lại toàn bộ mã bí mật. Dashboard sẽ yêu cầu bạn xác nhận, sau đó mở một hộp thoại hiển thị key ở dạng văn bản thuần túy, một nút sao chép và đồng hồ đếm ngược 15 giây. Sau khi đếm ngược kết thúc, hộp thoại sẽ xóa mã bí mật khỏi trang.
Mỗi lần tiết lộ đều được ghi lại trong audit log vì hành động này làm lộ thông tin xác thực đang hoạt động.
Các Key cũ
Các key được tạo trước khi tính năng này ra mắt sẽ hiển thị biểu tượng ổ khóa thay vì hình con mắt và không thể tiết lộ. Chỉ có mã băm của chúng được lưu trữ, do đó mã bí mật gốc không thể khôi phục. Để chuyển đổi một key cũ, hãy nhấp vào menu hành động và chọn Regenerate. Mã bí mật mới sẽ có thể tiết lộ kể từ thời điểm đó.
Ai có quyền tiết lộ
| Vai trò | Có thể tiết lộ |
|---|---|
| Key owner | Có |
| Org owner / admin (đối với org keys) | Có |
Thành viên nhóm có quyền write hoặc admin |
Có |
Thành viên nhóm có quyền read |
Không |
Chỉnh sửa một Key
Nhấp vào Edit trên bất kỳ hàng nào để cập nhật:
- Tên hiển thị và mô tả
- IP allowlist (mỗi dòng một IP; để trống để cho phép mọi IP nguồn)
- Ngày hết hạn (để trống nếu không hết hạn)
Các cài đặt khác (gán tổ chức, chủ sở hữu) không thể chỉnh sửa. Hãy tạo một key mới nếu bạn cần thay đổi quyền sở hữu.
Kích hoạt và Hủy kích hoạt
Sử dụng nút Disable / Enable trên hàng để chuyển đổi trạng thái của key. Việc hủy kích hoạt một key sẽ chặn tất cả các API request sử dụng key đó. Bạn có thể tái kích hoạt bất kỳ lúc nào. Thay đổi sẽ có hiệu lực trong vòng vài giây.
Tạo lại một Key
Nếu bạn nghi ngờ một key đã bị rò rỉ, hãy mở menu hành động (nút ba chấm) và chọn Regenerate. Thao tác này sẽ tạo ra một mã bí mật mới cho cùng một ID key. Mã bí mật cũ sẽ ngừng hoạt động ngay lập tức. Tất cả các cài đặt khác (tên, gán tổ chức, IP allowlist, ngày hết hạn) vẫn được giữ nguyên.
Mã bí mật mới vẫn có thể tiết lộ sau khi hộp thoại đóng lại, vì vậy bạn không cần phải sao chép chính xác ngay trong lần thử đầu tiên.
Xóa một Key
Mở menu hành động và chọn Delete. Theo mặc định, việc xóa sẽ hủy kích hoạt key (xóa mềm). Bạn có thể xóa vĩnh viễn key từ hộp thoại xác nhận.
Bạn sẽ nhận được một email thông báo khi một key bị xóa.
Các Key của Tổ chức
Các key được tạo dưới một tổ chức sẽ được chia sẻ với các thành viên tổ chức dựa trên vai trò của họ:
- Chủ sở hữu và quản trị viên có thể xem và chỉnh sửa tất cả các key của tổ chức.
- Thành viên chỉ xem được các key được gán cho các nhóm mà họ tham gia.
Các key của tổ chức sẽ tự động được thêm vào nhóm mặc định của tổ chức khi được tạo.
Quyền hạn Key thông qua Nhóm
Các nhóm kiểm soát ai có thể truy cập vào những key nào. Mỗi lượt gán key cho nhóm đều có một mức quyền hạn:
| Quyền hạn | Xem key | Tiết lộ | Chỉnh sửa cài đặt key |
|---|---|---|---|
| read | Có | Không | Không |
| write | Có | Có | Có |
| admin | Có | Có | Có |
Tài liệu liên quan
- Authentication: Cách các API key hoạt động với API
- Organizations and Teams: Thiết lập quyền truy cập chia sẻ
- Dashboard Overview: Tất cả các phần của dashboard