API Key là gì?
API Key là tên của một mã bí mật được gán cho một biểu mẫu (form) nhất định. API Key được gửi cùng các yêu cầu dịch vụ Web hoặc các yêu cầu tương tự nhằm xác định nguồn gốc của yêu cầu đó. API Key có thể được đưa vào phần tóm tắt của một yêu cầu để xác minh thêm nguồn gửi yêu cầu và ngăn chặn việc giả mạo giá trị này.
Cách thiết lập API Key
Nơi thiết lập
Vào Nền tảng mở (Open Platform) > API Key, nhấp vào API Key trong bảng điều khiển bên trái để tạo và thiết lập API Key.
Tạo API Key
1. Nhấp vào Tạo API Key (Create API Key) để tự động thêm một API Key mới.
2. API Key mặc định sẽ được ẩn, bạn có thể nhấp vào để hiển thị nó.
Đổi tên API Key
Nhấn vào API Key đã tạo, vào trang chi tiết, bạn có thể đổi tên API Key để dễ phân biệt với các khóa khác.
Thiết lập phạm vi (Scope)
Nhấp vào API Key, chuyển sang trang chi tiết, bạn có thể thiết lập Phạm vi (App) và Phạm vi (API) cho API Key đó.
1. Phạm vi (App)
- Tất cả ứng dụng (All Apps): Tất cả app trong Workspace Jodoo đều có thể sử dụng API Key này.
- Một số ứng dụng (Some Apps): Chỉ các app trong danh sách Ứng dụng (App List) được thêm mới sử dụng được API Key đó.
2. Phạm vi (API)
- Tất cả các API (All APIs): Mọi API trên Jodoo đều sử dụng được API Key bao gồm Contact API, App API, Form API, Data API, File API, Workflow API và CRM API.
- Một số API (Some APIs): Chỉ các API có trong Danh sách API được cho phép sử dụng API Key này.
Danh sách IP cho phép (IP Whitelist)
Sau khi thiết lập danh sách IP cho phép, API nền tảng mở chỉ chấp nhận các yêu cầu đến từ các IP này, mọi yêu cầu ngoài phạm vi sẽ bị từ chối.
Chọn API Key và nhấn Thêm IP mới trong mục IP Whitelist.
Bạn có thể đặt một địa chỉ IP hoặc dải địa chỉ IP. Nếu đặt dải IP, hãy thêm dấu * làm ký tự đại diện.
Kích hoạt/Vô hiệu hóa API Key
Bạn có thể kích hoạt hoặc vô hiệu hóa API Key đã tạo trong mục Trạng thái (Status). Các API Key bị vô hiệu hóa có thể được kích hoạt lại khi cần.
Sao chép API Key
1. Sao chép giá trị API Key: Nhấp vào trong mục API Key để nhanh chóng sao chép.
2. Sao chép toàn bộ API Key: Nhấp vào dưới mục Hành động (Action) để sao chép toàn bộ. Khi sao chép, phạm vi và danh sách IP cũng được sao chép, nhưng giá trị API Key mới sẽ được sinh ra.
Xóa API Key
Bạn có thể nhấn để xóa các API Key không còn cần thiết. Vì lí do an toàn, bạn nên xóa và tạo lại API Key định kỳ.
Bạn đã hoàn thành việc đọc. 🏆
