Motimate: Cách sử dụng API công khai của Motimate?

Sử dụng API công khai để tự động hóa việc tích hợp và đồng bộ hóa người dùng với nguồn dữ liệu của bạn, và kết nối Motimate với các dịch vụ khác 🔀

Giao diện lập trình ứng dụng công khai (Public API) là tập hợp các dịch vụ có thể được sử dụng để cập nhật và quản lý dữ liệu trong Motimate. Nó được tài liệu hóa theo một cách tiêu chuẩn, gọi là OpenAPI, và cung cấp cho các nhà phát triển quyền truy cập lập trình vào phần mềm của chúng tôi dưới dạng dịch vụ (SaaS). API này có phạm vi hỗ trợ rộng hơn so với SCIM và CSV, nhưng bạn cần sử dụng dịch vụ tích hợp hoặc phần mềm robot để sử dụng nó.

Việc ra mắt PAPI v2 giúp việc xuất dữ liệu từ MotiSpace của bạn trở nên dễ dàng hơn bao giờ hết, với các điểm cuối như:

• /motis/tiến triển
• /motis/hoàn thành chương
• /bài viết và
• /Nhận định/Bài học kinh nghiệm/Yêu cầu báo cáo

Mô hình dữ liệu

Giao diện lập trình ứng dụng (API) công khai cung cấp các mô hình để tự động hóa việc cấp quyền cho người dùng và đăng bài trên Pulse. Nó có các mô hình dữ liệu sau:

• Mô hình người dùng: Bạn có thể sử dụng mô hình này để đọc, ghi và cập nhật thông tin trên tài khoản người dùng. Điều này có thể bao gồm thông tin liên hệ, quyền truy cập và phân công nhóm cho quản lý moti. Nếu người dùng có một hoặc nhiều vị trí, điều này cũng có thể được thiết lập tại điểm cuối này.
   
• Mô hình nhóm: Cho phép bạn đọc, ghi và gán nhóm người dùng. Các nhóm này cũng có thể được tổ chức theo cấu trúc cây để phù hợp với tổ chức của bạn và đơn giản hóa việc phân công nhiệm vụ học tập. 
  
  Lưu ý quan trọng: Mức độ nhóm hiện tại được xác định bằng thuộc tính kind. Giá trị của sự tử tế có thể khác nhau tùy theo từng tổ chức. Nó cũng có thể được thay đổi dễ dàng bởi quản trị viên của tổ chức bạn. Khi thiết lập tích hợp API, nên định nghĩa một danh sách cố định các tên loại cho các cấp độ nhóm của bạn để tránh các lỗi tiềm ẩn trong quá trình tích hợp API nếu tên loại thay đổi.
   
• Mô hình vị trí: Mô hình này cho phép bạn đọc và ghi các vị trí mà tài khoản người dùng có thể được gán.
   
• Bài viết: Bạn có thể sử dụng tính năng này để tạo bài viết và đăng chúng lên Pulse. Điều này có thể được thực hiện kết hợp với dịch vụ tệp để tải lên hình ảnh.
   
• Tệp tin: Dịch vụ này được sử dụng để tải lên hình ảnh cho các bài đăng Pulse. Giới hạn kích thước cho hình ảnh là 40 MB, video là 100 MB và tài liệu là 100 MB.
   
• Thông tin chi tiết: Dịch vụ này được sử dụng để tạo và lấy liên kết đến một báo cáo tùy chỉnh. Mẫu báo cáo phải được tạo trước trên nền tảng Motimate bằng tính năng 'Generate Reports' trong mục 'Insights'.

Xác thực

Điểm cuối OAuth Token được sử dụng để tạo token truy cập. Nhận client_id và client_secret bằng cách liên hệ với support@motimateapp.com.

Sau khi nhận được các thông tin này, token có thể được tạo ra một cách tự động hoặc thông qua các nền tảng như Postman. Tất cả những gì bạn cần làm là gửi một yêu cầu API đến endpoint POST /oauth/tokens, kèm theo thông tin client_id và client_secret mà bạn đã nhận từ Motimate Support dưới dạng JSON.

API sẽ trả về một token duy nhất, có hiệu lực trong vòng 24 giờ. Bạn có thể tạo ra bao nhiêu token tùy ý. Token nên được truyền vào tiêu đề Authorization dưới dạng token Bearer trong các yêu cầu của bạn đến tất cả các endpoint khác (“Bearer “+[your_token]).

Ví dụ:
“Người mang eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD”
 

Bạn có thể sử dụng endpoint điểm cuối GET /me được sử dụng để xác minh token truy cập. Điều này hữu ích nếu bạn có một kho khóa (keystore) để lưu trữ token truy cập và muốn kiểm tra xem nó có hoạt động đúng cách hay không mà không cần thực hiện bất kỳ cuộc gọi giao dịch nào.