Skip to main content
Khóa API xác thực các yêu cầu gửi đến /v1 Public API. Mỗi khóa thuộc về một tài khoản dịch vụ và được tạo từ trang chi tiết của tài khoản đó trong Developer Hub. Hãy sử dụng khóa API có phạm vi giới hạn cho một tích hợp backend riêng tư khi việc lưu trữ và luân chuyển khóa bí mật một cách an toàn đáp ứng được yêu cầu của tổ chức Quý vị. Không cần máy khách OAuth hay bước trao đổi token. Xem Xác thực nếu tổ chức của Quý vị yêu cầu sử dụng token truy cập OAuth có thời hạn ngắn.

​
Cấu trúc của một khóa

  • Mã định danh — bắt đầu bằng ak_. Có thể an toàn tham chiếu trong phiếu yêu cầu, nhật ký và cấu hình; bản thân mã này không cấp bất kỳ quyền nào.
  • Khóa bí mật — bắt đầu bằng lsk_live_. Đây là thông tin xác thực mà tích hợp của Quý vị xuất trình. Khóa chỉ được hiển thị một lần, khi tạo hoặc luân chuyển, và không thể truy xuất lại sau đó. Danh sách khóa chỉ hiển thị bốn ký tự cuối (ví dụ lsk_live_…xQc4) để Quý vị đối chiếu một dòng với thông tin xác thực mà bên gọi đang nắm giữ.
  • Quyền của khóa — một tập con các quyền của tài khoản dịch vụ sở hữu, được chọn khi tạo. Một khóa không bao giờ có thể làm nhiều hơn những gì tài khoản của nó cho phép.
  • Thời điểm hết hạn — bắt buộc. Mỗi khóa đều có ngày hết hạn.
Hãy lưu khóa bí mật vào trình quản lý khóa bí mật ngay khi khóa được hiển thị. Không bao giờ commit khóa vào hệ thống quản lý phiên bản, nhúng vào mã phía máy khách, hoặc chia sẻ qua trò chuyện. Bất kỳ ai nắm giữ khóa bí mật đều có thể thực hiện hành động với các quyền của khóa đó.

​
Tạo khóa

Trên trang chi tiết của tài khoản dịch vụ, hãy tạo khóa qua bốn bước: đặt tên, chọn các quyền mà khóa cụ thể này cần, chọn thời hạn hết hạn — 30, 90 hoặc 365 ngày, hoặc một khoảng thời gian tùy chỉnh tối đa một năm — và xem lại. Khóa bí mật được hiển thị khi hoàn tất, chỉ một lần. Hãy giới hạn phạm vi của mỗi khóa ở tập quyền hẹp nhất mà bên gọi cần, ngay cả khi tài khoản cho phép nhiều hơn. Nếu khóa bị rò rỉ, các quyền của khóa chính là phạm vi ảnh hưởng.

​
Luân chuyển không gây gián đoạn

Luân chuyển sẽ cấp một khóa bí mật mới và bắt đầu một khoảng thời gian chồng lấp — 1 giờ, 24 giờ hoặc 7 ngày — trong đó khóa bí mật cũ vẫn hoạt động. Nhờ vậy Quý vị có thể triển khai khóa bí mật mới qua các môi trường triển khai theo tiến độ của mình:
1

Luân chuyển khóa

Chọn khoảng thời gian chồng lấp đủ bao phủ đường triển khai chậm nhất của Quý vị. Khóa bí mật mới chỉ hiển thị một lần — hãy lưu ngay lập tức.
2

Cập nhật các tích hợp của Quý vị

Thay khóa bí mật cũ ở mọi nơi nó được cấu hình. Trạng thái của khóa hiển thị là đang chồng lấp cho đến khi kết thúc khoảng thời gian này.
3

Xác minh trước khi khoảng thời gian chồng lấp kết thúc

Sử dụng nhật ký yêu cầu để xác nhận lưu lượng đã chuyển sang khóa bí mật mới. Khi khoảng chồng lấp kết thúc, khóa bí mật cũ sẽ không còn xác thực được nữa.
Cũng nên luân chuyển trước khi khóa hết hạn: các khóa sắp đến ngày hết hạn được đánh dấu là sắp hết hạn trong danh sách khóa. Khóa đã hết hạn sẽ không còn xác thực được — các yêu cầu sử dụng khóa đó trả về 401 với mã credential_expired.

​
Thu hồi ngay lập tức

Việc thu hồi có hiệu lực ngay lập tức và vĩnh viễn — không có khoảng thời gian chồng lấp và không thể hoàn tác. Hãy thu hồi khóa ngay khi Quý vị nghi ngờ khóa bí mật của nó đã bị lộ; hãy luân chuyển thay vì thu hồi khi Quý vị thay thế một thông tin xác thực vẫn an toàn. Các yêu cầu sử dụng khóa đã bị thu hồi trả về 401 với mã credential_revoked. Nếu Quý vị cần dừng cùng lúc mọi khóa mà một tích hợp đang nắm giữ, hãy vô hiệu hóa tài khoản dịch vụ của tích hợp đó.