Tài liệu › Dashboard › Quản lý API Key

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 dùng để gọi FourA API.

Xem các khóa của bạn

Trang hiển thị mọi khóa bạn có quyền truy cập: các khóa cá nhân của bạn và mọi khóa 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 nhìn thấy các khóa 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 Tiền tố được che (pk_live_••••••••) kèm nút Reveal, hoặc biểu tượng ổ khóa đối với khóa cũ
Status Active hoặc Inactive
Created Thời điểm khóa được tạo
Last Used Thời điểm khóa thực hiện request gần nhất

Tìm kiếm theo tên hoặc mô tả, lọc theo Active hoặc Inactive, và sắp xếp theo bất kỳ tiêu đề cột nào. Chiều sắp xếp sẽ xoay vòng theo thứ tự 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 bên cạnh ô tìm kiếm: Everything, Personal, hoặc một mục cho mỗi tổ chức. Nó sẽ thu hẹp danh sách về các khóa thuộc chủ sở hữu đó, và bộ điều khiển tương tự trên các trang Overview, Metrics, Activity và Proxy cũng sẽ đồng bộ theo lựa chọn của bạn, đảm bảo năm trang này luôn hiển thị lưu lượng truy cập của cùng một đối tượng.

Tạo khóa

Nhấp vào Create Key phía trên danh sách (Create API key trên trang trống trước khi bạn có khóa đầu tiên) và điền vào:

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 khóa 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 thuộc ít nhất một tổ chức.

Bất kỳ thành viên nào của tổ chức cũng có thể tạo khóa do tổ chức sở hữu, bất kể vai trò của họ là gì. Đó chính là mục đích của thiết lập này: mức sử dụng trên khóa của tổ chức sẽ được tính phí cho chủ sở hữu tổ chức, do đó nhà phát triển không cần phải dùng khóa cá nhân để rồi bị trừ phí vào tài khoản cá nhân thay vì công ty.

Khóa đầy đủ chỉ được hiển thị một lần ngay sau khi tạo trong hộp thoại có sẵn nút sao chép. Bạn có thể xem lại sau bằng Reveal. Các khóa sử dụng tiền tố pk_live_ và có định dạng như pk_live_a1b2c3d4e5f6.... Bạn sẽ nhận được email xác nhận rằng khóa đã được tạo.

Hiển thị khóa (Reveal)

Nhấp vào biểu tượng con mắt bên cạnh tiền tố bị che của khóa để xem lại toàn bộ chuỗi bí mật. Dashboard sẽ yêu cầu bạn xác nhận, sau đó mở một hộp thoại chứa khóa dạng văn bản thuần, nút sao chép và thời gian đếm ngược ngắn. Sau khi đếm ngược kết thúc, hộp thoại sẽ xóa chuỗi bí mật khỏi trang.

Mỗi lần hiển thị khóa đều được ghi lại trong 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ẻ khóa đều có thể hiển thị khóa đó: chủ sở hữu cá nhân, hoặc bất kỳ thành viên nào của tổ chức sở hữu khóa.

Khóa cũ

Các key được tạo trước khi tính năng hiển thị secret ra mắt sẽ có biểu tượng ổ khóa thay vì biểu tượng con mắt và không thể hiển thị. Hệ thống chỉ lưu trữ mã hash của chúng, do đó không thể khôi phục lại secret gốc. Để chuyển đổi key cũ, hãy mở menu thao tác và chọn Regenerate. Secret mới sẽ có thể hiển thị kể từ lúc đó.

Quyền hạn của từng vai trò

Đối với key cá nhân, bạn có toàn quyền thao tác. Đối với key của tổ chức, có ba cấp độ áp dụng:

Thao tác Thành viên Quản trị viên Chủ sở hữu
Sử dụng key và hiển thị secret Có Có Có
Đổi tên, chỉnh sửa mô tả Có Có Có
Bật hoặc vô hiệu hóa 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ó

Các nút Vô hiệu hóa và Chỉnh sửa vẫn hiển thị trên hàng nhưng bị làm mờ kèm ghi chú giải thích lý do. Các mục Tạo lại, Chuyển quyền sở hữu và Xóa sẽ không xuất hiện trong menu nếu vai trò của bạn không có quyền sử dụng. API cũng từ chối các thao tác tương tự, vì vậy các hệ thống tích hợp không thể vượt qua giới hạn giao diện.

Sự phân chia này dựa trên mức độ ảnh hưởng của từng thao tác đối với những người dùng chung key. Việc đổi tên là vô hại. Việc tạo lại hoặc vô hiệu hóa sẽ làm gián đoạn tích hợp của tất cả đồng nghiệp ngay lập tức. Việ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 riêng của người nhận, vì vậy quyền này chỉ thuộc về chủ sở hữu.

Chỉnh sửa key

Nhấp vào Edit để cập nhật tên và mô tả. Quyền sở hữu không thể thay đổi trong hộp thoại này: hãy sử 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

Sử dụng Disable hoặc Enable trên hàng tương ứng. Việc 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 vài giây.

Tạo lại key

Nếu nghi ngờ 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 một key ID. Secret cũ sẽ ngừng hoạt động ngay lập tức. 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 nhất thiết phải sao chép chính xác ngay trong lần đầu tiên.

Chuyển quyền sở hữu key

Mục Transfer trong menu thao tác giú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 giữ nguyên. Chỉ có chủ sở hữu thay đổi, kéo theo đối tượng chịu chi phí sử dụng thay đổi.

Thao tá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 tổ chức ra ngoài cho chính mình 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

Key được chuyển vào tổ chức sẽ tự động tham gia nhóm mặc định "Everyone", giúp các thành viên có thể nhìn thấy key. Key được chuyển ra ngoài sẽ rời khỏi tất cả các nhóm mà key từng thuộc về.

Xóa key

Mở menu thao tác và chọn Delete. Việc xóa khóa bạn đã từng sử dụng sẽ vô hiệu hóa khóa đó: khóa ngừng xác thực và vẫn hiển thị trong danh sách dưới dạng 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 dịch vụ 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 sẽ tính các khóa này cùng với các khóa cá nhân của họ và tách riêng hai nhóm.

Liên quan

Cập nhật: 30 tháng 9, 2026
← Tạo Tác vụ Metrics →