Cập nhật lần cuối: 18/02/2024
Giới thiệu
Lark Open Platform cung cấp các API theo phong cách RESTful, cho phép các nhà phát triển tích hợp và mở rộng chức năng của nền tảng Lark. Bài viết này sẽ hướng dẫn bạn qua các bước cần thiết để bắt đầu sử dụng API của Lark Open Platform một cách hiệu quả.
Định dạng URL yêu cầu
API của Lark Open Platform tuân theo cấu trúc URL chuẩn như sau:
https://open.larksuite.com/open-apis/<version>/<resource>
Quy trình tổng quan
Quy trình gọi API máy chủ của Lark Open Platform bao gồm các bước sau:
- Tạo ứng dụng
- Lấy mã truy cập (access token)
- Đăng ký phạm vi API
- (Tùy chọn) Cấu hình quyền truy cập dữ liệu
- (Tùy chọn) Thiết lập danh sách IP được phép
- Gọi API
Hãy cùng tìm hiểu chi tiết từng bước.
1. Tạo ứng dụng
Bước đầu tiên là tạo ứng dụng trong Developer Console của Lark. Bạn có hai lựa chọn:
- Ứng dụng tùy chỉnh: Phù hợp cho các dự án nội bộ hoặc tích hợp cụ thể.
- Ứng dụng cửa hàng: Dành cho các nhà phát triển muốn phân phối ứng dụng của họ trên Lark App Store.
Lưu ý: Chỉ những người dùng có đủ điều kiện ISV (Independent Software Vendor) mới có thể tạo ứng dụng cửa hàng. Để biết thêm thông tin về cách trở thành ISV trên Lark Open Platform, vui lòng tham khảo tài liệu hướng dẫn của họ.
2. Lấy mã truy cập (Access Token)
Access token là chìa khóa để truy cập API của Lark Open Platform. Nó đại diện cho quyền truy cập vào các tài nguyên cụ thể. Lark Open Platform cung cấp nhiều loại access token khác nhau, mỗi loại có phạm vi quyền truy cập riêng.
Khi gọi API, bạn cần đính kèm access token vào tiêu đề HTTP để xác thực và truy cập tài nguyên trong phạm vi quyền được định nghĩa.
3. Đăng ký phạm vi API (API Scopes)
Trước khi có thể gọi bất kỳ API nào, bạn phải đăng ký phạm vi (scope) tương ứng. Phạm vi xác định những gì ứng dụng của bạn được phép làm với API.
Đối với các trường dữ liệu nhạy cảm, bạn cần đăng ký phạm vi bổ sung để truy cập chúng.
4. Cấu hình quyền truy cập dữ liệu (Tùy chọn)
Một số API, như API Danh bạ (Contacts) hoặc Lark HR Enterprise Edition, yêu cầu cấu hình quyền truy cập dữ liệu bổ sung. Quy trình này bao gồm:
- Cấu hình quyền truy cập dữ liệu cụ thể
- Gửi cấu hình để xem xét
- Chờ phê duyệt
Chỉ sau khi được phê duyệt, ứng dụng của bạn mới có thể truy xuất dữ liệu thông qua các API này. Nếu không, bạn sẽ nhận được lỗi ủy quyền khi gọi API.
5. Thiết lập danh sách IP được phép (Tùy chọn)
Để tăng cường bảo mật cho ứng dụng, bạn có thể thiết lập danh sách IP được phép (IP whitelist). Khi được cấu hình, Lark Open Platform sẽ chỉ phản hồi các yêu cầu đến từ các địa chỉ IP trong danh sách này. Mọi yêu cầu từ các IP khác sẽ bị từ chối.
6. Gọi API
Sau khi hoàn thành các bước trên, bạn đã sẵn sàng để gọi API của Lark Open Platform. Hãy tham khảo tài liệu API chi tiết để hiểu rõ về chức năng cụ thể của từng API và cách sử dụng chúng.
Kết luận
Bằng cách tuân theo quy trình này, bạn có thể bắt đầu tích hợp các tính năng của Lark vào ứng dụng của mình một cách an toàn và hiệu quả. Hãy nhớ rằng việc hiểu rõ về phạm vi API, quyền truy cập dữ liệu và các biện pháp bảo mật như danh sách IP được phép là rất quan trọng để xây dựng các ứng dụng mạnh mẽ và đáng tin cậy trên nền tảng Lark.