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 hiển thị mọi key bạn có quyền truy cập: các key cá nhân của bạn và mọi key thuộc sở hữu của tổ chức mà bạn tham gia. Quyền thành viên là yếu tố cấp quyền truy cập, vì vậy một thành viên thông thường cũng thấy được các key của tổ chức.
| Cột | Nội dung hiển thị |
|---|---|
| Name | Tên hiển thị và mô tả nếu bạn đã thiết lập |
| Owner | Personal, hoặc tên của tổ chức |
| Key Prefix | Các ký tự đầu tiên của key, tiếp theo là phần che giấu (pk_live_a1b2••••••••), đi kèm nút Reveal, hoặc biểu tượng ổ khóa đối với key cũ |
| Status | Active hoặc Inactive |
| Created | Thời điểm key được tạo |
| Last Used | Thời điểm key gửi request lần cuối |
Tìm kiếm theo tên hoặc mô tả, lọc theo Active hoặc Inactive, và sắp xếp theo Name, Owner, Status, Created, hoặc Last Used. Hướng sắp xếp luân chuyển giảm dần, tăng dần, rồi tắt.
Bộ lọc Owner
Nếu bạn thuộc về ít nhất một tổ chức, menu thả xuống Owner sẽ xuất hiện cạnh hộp tìm kiếm: Everything, Personal, hoặc một mục cho mỗi tổ chức. Bộ lọc này giới hạn danh sách ở các key có owner đó, và bộ điều khiển tương tự trên Overview, Metrics, Activity, và Proxy sẽ đồng bộ theo lựa chọn của bạn, giúp năm trang luôn thống nhất về lưu lượng bạn đang xem.
Tạo một key
Nhấp vào Create Key phía trên danh sách (Create API key trên trang trống trước khi có key đầu tiên) và điền:
| 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 key này |
| Owner | Có nếu bạn thuộc một tổ chức | Personal, hoặc bất kỳ tổ chức nào bạn tham gia. Bộ chọn chỉ xuất hiện khi bạn có ít nhất một tổ chức. |
Bất kỳ thành viên nào của tổ chức đều có thể tạo key thuộc sở hữu của tổ chức đó, bất kể vai trò của họ. Đó là mục đích của thiết lập này: mức sử dụng trên key của tổ chức sẽ tính phí cho chủ sở hữu của tổ chức, vì vậy nhà phát triển không cần dùng key cá nhân để rồi bị tính phí thay vì công ty.
Key đầy đủ được hiển thị một lần ngay sau khi tạo trong hộp thoại có thể sao chép. Bạn có thể xem lại sau bằng Reveal. 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 email xác nhận key đã được tạo.
Gói dịch vụ của bạn xác định số lượng active key bạn có thể nắm giữ: các key cá nhân cộng với key của các tổ chức bạn sở hữu. Một key được tạo cho tổ chức sẽ tính vào giới hạn gói dịch vụ của chủ sở hữu tổ chức đó. Khi đạt giới hạn, việc tạo key sẽ bị từ chối kèm thông báo nêu rõ con số của gói dịch vụ, vì vậy hãy tắt hoặc xóa key bạn không còn sử dụng, hoặc nâng cấp gói.
Hiển thị lại key
Nhấp vào biểu tượng con mắt cạnh phần tiền tố bị che của key để xem lại secret đầy đủ. Bảng điều khiển sẽ yêu cầu bạn xác nhận, sau đó mở hộp thoại chứa key dạng văn bản rõ, nút sao chép và đồng hồ đếm ngược ngắn. Sau khi đếm ngược kết thúc, hộp thoại sẽ xóa secret khỏi trang.
Mỗi lần hiển thị lại key đều được ghi vào audit log, vì thao tác này làm lộ thông tin xác thực đang hoạt động.
Bất kỳ ai được chia sẻ key đều có thể xem key: chủ sở hữu cá nhân, hoặc bất kỳ thành viên nào trong tổ chức sở hữu key đó.
Khóa cũ
Các key được tạo trước khi tính năng hiển thị secret ra mắt sẽ hiển thị biểu tượng ổ khóa thay vì biểu tượng con mắt và không thể hiển thị nội dung. Hệ thống chỉ lưu trữ mã hash của chúng, vì vậy không thể khôi phục secret gốc. Để chuyển đổi một key cũ, hãy mở menu thao tác và chọn Regenerate. Secret mới sẽ có thể xem được kể từ thời điểm đó.
Quyền hạn của từng vai trò
Với key cá nhân, bạn có toàn quyền thao tác. Với key của tổ chức, áp dụng ba cấp độ sau:
| Thao tác | Thành viên | Quản trị viên | Chủ sở hữu |
|---|---|---|---|
| Sử dụng key và xem secret | Có | Có | Có |
| Đổi tên, chỉnh sửa mô tả | Có | Có | Có |
| Bật hoặc tắt key | Không | Có | Có |
| Tạo lại secret | Không | Có | Có |
| Xóa key | Không | Có | Có |
| Chuyển key ra khỏi tổ chức | Không | Không | Có |
Disable và Edit vẫn hiển thị trên dòng tương ứng nhưng bị làm mờ kèm ghi chú nêu rõ lý do. Regenerate, Transfer và Delete sẽ không xuất hiện trong menu nếu vai trò của bạn không thể sử dụng chúng. API cũng từ chối các thao tác tương tự, vì vậy các tích hợp không thể vượt qua giới hạn giao diện.
Việc phân quyền dựa trên mức độ ảnh hưởng của từng thao tác đối với những người đang dùng chung key. Đổi tên hoàn toàn vô hại. Tạo lại secret hoặc vô hiệu hóa key sẽ làm gián đoạn tích hợp của tất cả đồng nghiệp ngay lập tức. Chuyển key ra ngoài sẽ rút key khỏi công ty và tính mức sử dụng vào gói của chính người nhận, vì vậy quyền này thuộc về riêng chủ sở hữu.
Chỉnh sửa key
Nhấp vào Edit để cập nhật tên và mô tả. Không thể thay đổi quyền sở hữu trong hộp thoại này: hãy dùng Transfer.
Mục View Metrics trong menu thao tác sẽ mở trang Tổng quan được lọc theo key đó.
Kích hoạt và vô hiệu hóa
Dùng Disable hoặc Enable trên dòng tương ứng. Vô hiệu hóa một key sẽ chặn mọi API request sử dụng key đó, và bạn có thể kích hoạt lại bất kỳ lúc nào. Thay đổi có hiệu lực trong vòng một phút.
Tạo lại secret cho key
Nếu bạn nghi ngờ một key đã bị lộ, hãy mở menu thao tác và chọn Regenerate. Thao tác này sẽ tạo một secret mới cho cùng key ID đó. Secret cũ sẽ ngừng hoạt động trong vòng một phút. Tên, chủ sở hữu và mọi cài đặt khác vẫn được giữ nguyên.
Secret mới vẫn có thể xem lại sau khi đóng hộp thoại, vì vậy bạn không cần phải sao chép chính xác ngay trong lần đầu tiên.
Chuyển giao key
Mục Transfer trong menu thao tác cho phép chuyển 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, số liệu đo lường và lịch sử hoạt động vẫn được bảo toàn. Chỉ có chủ sở hữu thay đổi, kéo theo đối tượng chịu chi phí sử dụng thay đổi.
| Hình thức chuyển | Người có quyền thực hiện |
|---|---|
| Key cá nhân vào một tổ chức | Bất kỳ ai thuộc tổ chức đó |
| Key của tổ chức ra ngoài, cho chính bạn | Chủ sở hữu của tổ chức |
| Giữa hai tổ chức | Chủ sở hữu của tổ chức mà key đang rời đi |
Một key khi chuyển vào tổ chức sẽ tự động tham gia nhóm mặc định "Everyone", nhờ đó các thành viên có thể nhìn thấy key. Một key khi chuyển ra ngoài sẽ rời khỏi tất cả các nhóm mà nó từng tham gia.
Xóa key
Mở menu hành động và chọn Delete. Việc xóa một khóa bạn từng sử dụng trước đây sẽ vô hiệu hóa khóa đó: khóa dừng xác thực và vẫn hiển thị trên danh sách dưới trạng thái Inactive, nhờ đó lịch sử Activity và Metrics vẫn giữ lại tên của khóa. Các khóa chưa từng được sử dụng sẽ bị xóa hoàn toàn.
Bạn sẽ nhận được email khi một khóa bị xóa.
Khóa tổ chức và thanh toán
Mức sử dụng trên khóa thuộc sở hữu của tổ chức được tính vào gói của chủ sở hữu tổ chức, bất kể ai là người gửi request. Trang Usage & Limits của chủ sở hữu tính các khóa đó cùng với các khóa cá nhân của họ và tách riêng cả hai.
Liên quan
- Authentication: Cách API key hoạt động với API
- Organizations: Vai trò, thành viên và quyền truy cập dùng chung
- Usage & Limits: Những khóa nào được tính vào gói của bạn
- Dashboard Overview: Tất cả các phần trong dashboard