Quản lý API Key
Trang API Keys cho phép bạn tạo, xem và quản lý các khóa mà ứng dụng của bạn sử dụng để gọi FourA API.
Xem Khóa Của Bạn
Trang hiển thị mọi khóa mà bạn có quyền truy cập:
- Khóa cá nhân do bạn trực tiếp tạo.
- Khóa tổ chức nếu bạn là chủ sở hữu hoặc quản trị viên tổ chức, hoặc nếu khóa bạn sở hữu đã được chuyển sang một trong các tổ chức của bạn.
Mỗi hàng trong bảng hiển thị:
| Cột | Nội dung hiển thị |
|---|---|
| Tên | Tên hiển thị và (tùy chọn) mô tả |
| Khóa | Tiền tố được che lấp (ví dụ: pk_live_••••••••) với nút Tiết lộ bên cạnh |
| Chủ sở hữu | Personal đối với khóa cá nhân, hoặc tên tổ chức đối với khóa thuộc sở hữu của tổ chức |
| Trạng thái | Hoạt động hoặc Không hoạt động |
| Đã tạo | Thời điểm khóa được tạo |
| Lần dùng cuối | Thời điểm khóa thực hiện request gần nhất |
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 khóa đang hoạt động hoặc không hoạt động. Mọi tiêu đề cột đều có thể sắp xếp.
Tạo Khóa
Nhấp vào Tạo Khóa và điền:
| Trường | Bắt buộc | Mô tả |
|---|---|---|
| Tên | Có | Nhãn mô tả (ví dụ: "production-scraper" hoặc "staging-test") |
| Mô tả | Không | Ghi chú về mục đích sử dụng của khóa này |
| Chủ sở hữu | Có nếu bạn ở trong một tổ chức | Cá nhân hoặc một trong những tổ chức bạn thuộc về. Trình chọn chỉ xuất hiện khi bạn có ít nhất một tổ chức. |
Toàn bộ khóa được hiển thị một lần 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 khóa sau qua Tiết lộ (xem bên dưới).
Các khóa sử dụng tiền tố pk_live_ và trông giống như pk_live_a1b2c3d4e5f6.... Bạn sẽ nhận được email xác nhận khi một khóa mới được tạo.
Tiết Lộ Một Khóa
Nhấp vào biểu tượng con mắt bên cạnh tiền tố bị ẩn của khóa để xem lại secret đầy đủ của nó. Bảng điều khiển yêu cầu bạn xác nhận, sau đó mở một hộp thoại với khóa văn bản thuần túy, nút sao chép và thời gian đếm ngược ngắn. Sau thời gian đếm ngược, hộp thoại sẽ xóa secret khỏi trang.
Mọi tiết lộ đều được ghi lại trong nhật ký kiểm tra vì nó làm lộ một thông tin xác thực trực tiếp.
Khóa Cũ
Các khóa được tạo trước khi tính năng tiết lộ xuất xưởng sẽ hiển thị biểu tượng ổ khóa thay vì con mắt và không thể được tiết lộ. Chỉ có hàm băm của chúng được lưu trữ, vì vậy secret ban đầu không thể khôi phục được. Để chuyển đổi một khóa cũ, hãy nhấp vào menu hành động và chọn Tạo lại. Secret mới có thể được tiết lộ từ đó trở đi.
Ai Có Thể Tiết Lộ
| Vai trò | Có thể tiết lộ |
|---|---|
| Chủ sở hữu khóa | Có |
| Chủ sở hữu hoặc quản trị viên tổ chức (đối với khóa thuộc sở hữu tổ chức) | Có |
| Bất kỳ ai khác | Không |
Chỉnh Sửa Một Khóa
Nhấp vào Chỉnh sửa trên bất kỳ hàng nào để cập nhật tên hiển thị và mô tả. Quyền sở hữu (cá nhân so với tổ chức) không được thay đổi ở đây. Sử dụng Chuyển nhượng bên dưới để di chuyển khóa giữa các chủ sở hữu.
Kích Hoạt và Hủy Kích Hoạt
Sử dụng nút Vô hiệu hóa / Kích hoạt trên hàng để chuyển đổi trạng thái của khóa. Hủy kích hoạt một khóa sẽ chặn tất cả các request API sử dụng nó. Bạn có thể kích hoạt lại khóa đó bất kỳ lúc nào. Thay đổi có hiệu lực trong vòng vài giây.
Tạo Lại Một Khóa
Nếu bạn nghi ngờ một key đã bị lộ, hãy mở menu hành động (nút ba chấm) và chọn Regenerate. Thao tác này tạo một secret mới cho cùng một key ID. Secret cũ sẽ ngừng hoạt động ngay lập tức. Tên, việc gán tổ chức và các cài đặt khác vẫn giữ nguyên.
Secret mới vẫn có thể xem được sau khi đóng hộp thoại, do đó bạn không cần phải sao chép chính xác ngay trong lần thử đầu tiên.
Chuyển nhượng Key
Mỗi hàng đều có hành động Transfer trong menu. Hãy sử dụng nó để di chuyển một key giữa quyền sở hữu cá nhân và tổ chức mà không cần tạo lại secret. Key ID, các số liệu (metrics) và lịch sử hoạt động (activity) của nó được giữ nguyên; chỉ có chủ sở hữu thay đổi.
Các trường hợp phổ biến:
- Di chuyển một personal key mà bạn đã tạo cho một dự án dùng chung vào tổ chức (org) để đồng đội có thể quản lý nó sau bạn.
- Gán lại một org key cho chính bạn nếu dự án tách riêng.
Bạn có thể chuyển một key do bạn sở hữu (cá nhân) vào bất kỳ org nào mà bạn là chủ sở hữu (owner) hoặc quản trị viên (admin), và bạn có thể chuyển một org key mà bạn quản lý cho chính mình hoặc giữa các org mà bạn quản lý.
Xóa Key
Mở menu hành động và chọn Delete. Việc xóa một key bạn đã sử dụng trước đây sẽ xóa mềm (soft-delete) key đó: key ngừng xác thực nhưng lịch sử Activity và Metrics của nó vẫn còn nguyên vẹn. Các key chưa bao giờ được sử dụng có thể bị xóa cứng (hard-delete).
Bạn sẽ nhận được thông báo qua email khi một key bị xóa.
Organization Key
Các key thuộc sở hữu của một tổ chức sẽ hiển thị cho các chủ sở hữu và quản trị viên của tổ chức đó. Các thành viên không có vai trò chủ sở hữu hoặc quản trị viên sẽ không thấy chúng.
Mức sử dụng trên một org key sẽ được tính vào gói cước của chủ sở hữu tổ chức.
Liên quan
- Xác thực: Cách API key hoạt động với API
- Tổ chức và Nhóm: Thiết lập quyền truy cập chung
- Tổng quan Dashboard: Tất cả các mục trong bảng điều khiển