Khóa API và khoá nhúng

Fresco BI có hai loại khóa bí mật. Cả hai chỉ hiện một lần, ngay khi bạn tạo.

	Khóa API	Khoá nhúng
Dùng cho	Script của bạn gọi Fresco BI API	Máy chủ của bạn, để nhúng report vào website hoặc ứng dụng
Thuộc về	Bạn, trong một tổ chức	Một workspace
Làm được gì	Những gì bạn làm được, không hơn, trong phạm vi của khóa	Tạo token nhúng ngắn hạn cho các report bạn chọn
Ai tạo	Mọi thành viên, khi tổ chức cho phép khóa API	Quản trị viên workspace, Chủ sở hữu và Quản trị viên tổ chức
Ở đâu	Menu tài khoản › Khóa API	Workspace › Khoá nhúng ở menu bên trái

Khóa API

Trước khi bắt đầu

Tổ chức phải cho phép khóa API cá nhân. Nếu chưa, menu tài khoản không có mục Khóa API và trang báo Tổ chức này chưa cho phép khóa API cá nhân.

Tạo khóa API

Ở cuối menu bên trái, bấm vào ô có ảnh đại diện và tên của bạn, rồi bấm Khóa API.
Bấm Tạo khóa.
Điền biểu mẫu:
- Tên: tối đa 100 ký tự, để bạn biết khóa dùng vào việc gì.
- Phạm vi: chọn những gì khóa được làm: reports:read, data-tables:read, data-tables:refresh, exports:create.
- Hết hạn: 7, 30, 90 hoặc 365 ngày. Không có khóa vô thời hạn.
- Chỉ cho phép từ IP: không bắt buộc. Mỗi dòng một dải CIDR, ví dụ 203.0.113.0/24, tối đa 20 dòng. Khi đó khóa chỉ dùng được từ các địa chỉ này.
Bấm OK.
Khóa mới hiện ra cùng dòng Sao chép khóa ngay bây giờ. Bạn sẽ không xem lại được. Hãy sao chép và cất ở nơi an toàn.

Dùng khóa API

Script của bạn gửi khóa trong header Authorization: Bearer <khóa>. Mỗi yêu cầu chạy với tư cách của bạn, theo vai trò và bảo mật cấp hàng hiện tại của bạn, và chỉ trong phạm vi của khóa.

Mỗi tổ chức, bạn có tối đa 10 khóa đang dùng.
Mỗi khóa gửi được tối đa 60 yêu cầu mỗi phút.

Tài liệu tham khảo API sắp ra mắt.

Xem và thu hồi khóa

Danh sách hiện Tên, Phạm vi, 4 ký tự cuối của khóa (fbi_…), ngày Hết hạn, và lần Dùng lần cuối kèm địa chỉ IP.

Để ngừng một khóa, bấm Thu hồi rồi xác nhận. Script dùng khóa sẽ ngừng chạy ngay. Khóa đã thu hồi hoặc hết hạn hiện Đã thu hồi hoặc Hết hạn; hãy tạo khóa mới.

Khóa cũng ngừng hoạt động khi bạn rời tổ chức, hoặc khi tổ chức không còn cho phép khóa API.

Khoá nhúng

Khoá nhúng dùng cho nhúng bảo mật: máy chủ của bạn đổi khoá nhúng lấy token nhúng ngắn hạn, rồi trang web dùng token đó để hiện report. Bảo mật cấp hàng vẫn được áp dụng. Xem Nhúng report.

Trước khi bắt đầu

Bạn cần là Quản trị viên của workspace, hoặc Chủ sở hữu hay Quản trị viên của tổ chức. Người khác sẽ thấy Chỉ quản trị viên workspace quản lý khoá nhúng.
Khoá nhúng dùng được ở mọi gói.

Tạo khoá nhúng

Ở menu bên trái, mở Workspace › Khoá nhúng. Bạn cũng mở được từ một report: Nhúng, Nhúng bảo mật (khoá nhúng), rồi Mở Khoá nhúng của workspace.
Bấm Tạo khoá nhúng.
Điền biểu mẫu:
- Tên: tối đa 100 ký tự.
- Phạm vi: Tất cả báo cáo trong workspace, hoặc Chọn báo cáo và chọn tối đa 100 report.
- Hết hạn sau: 30, 90, 180 hoặc 365 ngày.
- Website được phép (tuỳ chọn): mỗi dòng một origin, ví dụ https://portal.example.com, tối đa 20 dòng. Dùng https://; http:// chỉ dùng được cho localhost. Để trống thì mọi website đều được.
Bấm Tạo khoá nhúng trong hộp thoại.
Sao chép token trong hộp Khoá nhúng mới. Token chỉ hiện một lần.

Mỗi workspace có tối đa 20 khoá nhúng đang hoạt động. Mọi thao tác với khoá nhúng đều được ghi vào nhật ký kiểm toán.

Dùng khoá nhúng

Máy chủ của bạn gọi POST /api/embed/token bằng khoá nhúng. Kết quả là một token nhúng có hiệu lực tối đa 60 phút. Trang web của bạn chuyển token nhúng đó cho khung report. Hộp thoại Nhúng của report có mã mẫu cho cả hai phía.

Xoay vòng hoặc thu hồi khoá nhúng

Danh sách hiện tên và 4 ký tự cuối của token, Phạm vi, ngày Hết hạn, lần Dùng lần cuối và Trạng thái: Đang hoạt động, Đã thu hồi hoặc Hết hạn.

Xoay vòng tạo secret mới và thu hồi secret cũ ngay. Hãy sao chép token mới và cập nhật máy chủ.
Thu hồi dừng token. Mọi token nhúng tạo từ nó sẽ ngừng ngay.

Đánh dấu Hiện token đã thu hồi để xem cả các token đã thu hồi.