/v1 thao tác,
được nhóm theo tài nguyên, với xác thực được cấu hình sẵn.
Tải xuống
Các liên kết tải xuống sẽ yêu cầu Quý khách đăng nhập bằng tài khoản Living Security
trước khi tệp được cung cấp.
Bộ sưu tập Living Security API v1
Postman Collection v2.1 với toàn bộ
/v1 thao tác và xác thực Basic
được cấu hình sẵn. Bộ sưu tập baseUrl để trống — hãy chọn một môi trường
theo khu vực trước khi Quý khách gửi yêu cầu.Tải xuống bộ sưu tậpMôi trường Production (US)
baseUrl được đặt sẵn là https://api.us-east-1.livingsecurity.ai/v1, với
các biến apiKeySecret và contractVersion để trống cần điền.Tải xuống môi trường production USMôi trường Production (EU)
baseUrl được đặt sẵn là https://api.eu-west-1.livingsecurity.ai/v1, với
các biến apiKeySecret và contractVersion để trống cần điền.Tải xuống môi trường production EUMẫu môi trường
Các biến tương tự với
baseUrl để trống, dành cho các thiết lập không phải production.Tải xuống mẫu môi trườngThiết lập trong Postman
1
Nhập các tệp
Trong Postman, chọn Import và thả vào tệp bộ sưu tập cùng với môi trường
Production (US) hoặc Production (EU) phù hợp với tổ chức của Quý khách. Xem Khu vực.
2
Tạo khóa API
Trong Bảng điều khiển, mở Cài đặt → Integrations & Developers →
Developer Hub, tạo một tài khoản dịch vụ, rồi tạo một khóa API. Mã bí mật của khóa bắt đầu bằng
lsk_live_ và
chỉ hiển thị một lần — hãy sao chép ngay lập tức. Xem
Khóa API để biết thêm chi tiết.3
Dán mã bí mật
Đặt giá trị cho biến
apiKeySecret — trong môi trường đã nhập
(khuyến nghị; đây là biến loại bí mật) hoặc trong tab Biến
của bộ sưu tập.4
Gửi yêu cầu
Chọn môi trường theo khu vực đã nhập, mở một yêu cầu bất kỳ — ví dụ
Tổ chức → Retrieve the organization — và nhấp Gửi. Không được
gửi khi chưa chọn môi trường; biến
baseUrl của bộ sưu tập được để trống
có chủ đích.Cách xác thực được cấu hình sẵn
Bộ sưu tập thiết lập xác thực Basic ở cấp bộ sưu tập với tên người dùngapikey
và mật khẩu {{apiKeySecret}}. API chấp nhận mã bí mật của khóa ở một trong hai trường
của xác thực Basic, nên cấu hình này hoạt động ngay khi biến được đặt giá trị.
Nếu Quý khách muốn dùng xác thực bearer, hãy đổi loại Authorization của bộ sưu tập
thành Bearer Token và dùng {{apiKeySecret}} làm token — API
chấp nhận cùng một mã bí mật theo cả hai cách.
Việc dùng tiêu đề Bearer với khóa API không yêu cầu OAuth. Để dùng OAuth,
hãy đặt Bearer Token là access token OAuth của Quý khách thay vì mã bí mật của khóa API.
Xem Xác thực để chọn phương thức và
Thông tin xác thực máy khách OAuth để thiết lập token và máy khách.
Tiêu đề phiên bản hợp đồng
Mỗi yêu cầu đều có tiêu đềLiving-Security-Version được đặt sẵn là
{{contractVersion}}, mặc định bị tắt. Hãy để tắt để dùng phiên bản hợp đồng
được ghim cho tổ chức của Quý khách. Hãy bật để ghim yêu cầu vào một
phiên bản cụ thể đã được công bố — xem nhật ký thay đổi
để biết các phiên bản đã công bố.
Tham số truy vấn và nội dung yêu cầu
Các bộ lọc của endpoint danh sách (limit, page_token và các bộ lọc riêng theo tài nguyên)
được đưa vào từng yêu cầu nhưng bị tắt, nên một lần nhập mới sẽ gọi thành công mọi
endpoint. Hãy bật và điền những bộ lọc Quý khách cần — xem
Phân trang để biết cách page_token hoạt động. Nội dung
yêu cầu của các thao tác POST được điền sẵn bằng các giá trị giữ chỗ theo kiểu dữ liệu.
Bộ sưu tập được tạo lại từ đặc tả OpenAPI đã công bố mỗi khi hợp đồng
thay đổi — hãy tải xuống một bản mới thay vì chỉnh sửa các yêu cầu mà Quý khách
muốn giữ luôn cập nhật.