Trong trang này
> tai nguyen > tai lieu > api > API key

API key

Quản lý API key trong ProcessMind

Để tích hợp với API ProcessMind, bạn cần tạo và quản lý API key. Tìm hiểu cách tạo, sử dụng và bảo vệ API key.

Trong phần cài đặt tài khoản ProcessMind, hãy mở mục “API key”. Nhấp vào nút Khóa API môi trường mới để tạo API key. Đặt tên cho key để sau này dễ nhận ra.

Tạo API key

image

Bạn có thể tạo nhiều API key cho các ứng dụng hoặc dịch vụ khác nhau. Quản lý từng key riêng biệt, nên bạn có thể thu hồi key khi cần mà không ảnh hưởng đến các kết nối khác. Sau khi tạo key, hãy sao chép và lưu ở nơi an toàn. Vì lý do bảo mật, key chỉ hiển thị một lần khi tạo.

image

warning

Hãy bảo vệ API key, không đưa key vào mã chạy phía client hoặc kho mã công khai. Nếu key bị lộ, hãy thu hồi ngay và tạo key mới.

API key của tổ chức

Quản trị viên tổ chức cũng có thể tạo API key của tổ chức ngay trên trang này. Khác với key theo môi trường, key của tổ chức dùng được trên mọi môi trường (tenant) thuộc tổ chức, nên một kết nối có thể phục vụ tất cả. Dùng API key của tổ chức để:

  • Cấp API key cho môi trường: tạo, cập nhật và xóa key theo tenant thông qua External API (/v1/tenant/{tenantId}/api-keys).
  • Tạo liên kết đăng nhập dùng một lần: đưa người dùng từ sản phẩm của bạn thẳng vào ProcessMind, với phiên đăng nhập đã được xác thực (/v1/tenant/{tenantId}/users/{userId}/login-token).

Phạm vi quyền

Phạm vi quyền Quyền được cấp
read Đọc dữ liệu tenant (các endpoint liệt kê/lấy dữ liệu). Bật mặc định.
write Tạo, cập nhật và xóa dữ liệu tenant. Bật mặc định.
uploadData Yêu cầu URL tải lên có chữ ký trước cho datatable. Bật mặc định.
sessions Tạo token chuyển tiếp đăng nhập dùng một lần. Tắt mặc định.

Chỉ bật sessions cho key cần chuyển tiếp đăng nhập. Hãy bảo vệ key như mật khẩu: token được tạo sẽ đăng nhập người dùng mà không yêu cầu nhập mật khẩu. API key của tổ chức có thể tạo token cho người dùng ở mọi môi trường trong tổ chức; key theo môi trường chỉ tạo token cho người dùng thuộc chính môi trường đó.

Chuyển tiếp đăng nhập dùng một lần

POST /v1/tenant/{tenantId}/users/{userId}/login-tokenTrả về mã thông báo chỉ dùng một lần, có hiệu lực trong 60 giây và gắn với người dùng, môi trường cùng tổ chức, kèm theo một url. Chuyển trình duyệt của người dùng đến URL đó để họ vào ProcessMind bằng phiên riêng, không cần liên kết qua email và không mạo danh người dùng. Bạn có thể gửi thêm path trong phần thân yêu cầu để mở thẳng một trang cụ thể. Khóa phải có phạm vi sessions, và chỉ có thể tạo người dùng cho tenant mà khóa được phép phục vụ.

Mọi yêu cầu tạo token đều được ghi nhật ký kiểm tra và giới hạn tần suất chặt chẽ. Yêu cầu sẽ bị chặn ngay nếu key bị vô hiệu hóa hoặc người dùng mất quyền truy cập. Token chỉ được trả về một lần và không bao giờ được ghi vào nhật ký.

Chủ đề liên quan

Tài liệu liên quan

Thiết kế quy trình tốt hơn. Kết nối các quy trình. Luôn chủ động kiểm soát.

Truy cập ngay, không cần thẻ tín dụng hay chờ đợi. Biến cách tổ chức của bạn vận hành thành các thiết kế quy trình rõ ràng, liên kết với nhau.

Xây dựng kiến trúc quy trình, xác định quyền sở hữu và cơ chế kiểm soát, đồng thời thống nhất vai trò và trách nhiệm ở mọi cấp.

Bắt đầu dùng thử miễn phí để tạo nền tảng đáng tin cậy cho việc quản trị, quản lý và cải tiến quy trình liên tục.

Dùng thử miễn phí ngay