Motimate: Cách sử dụng API công khai để tạo và quản lý người dùng và nhóm?

Bạn có thể tạo và quản lý người dùng trong Motimate bằng cách kết nối hệ thống nguồn của bạn với API REST của chúng tôi. Điều này cho phép bạn thực hiện các tác vụ chính trong Motimate như tạo người dùng, cập nhật thông tin người dùng, xóa người dùng, tạo nhóm và phân quyền người dùng vào các nhóm tương ứng. 

Thông tin cơ bản: 

• Tất cả người dùng và nhóm đều có ID Motimate duy nhất của riêng mình, có thể sử dụng với API, nhưng bạn cũng có thể định nghĩa một 'ID bên ngoài' để sử dụng với API. Mã ID bên ngoài này thường được đặt để khớp với mã ID của người dùng hoặc nhóm đó trong nguồn dữ liệu của bạn. 
   
• Nhóm được sử dụng để tạo ra một cấu trúc phân cấp hoặc cây nhóm. Điều này thường phản ánh chặt chẽ cấu trúc tổ chức của bạn và được sử dụng để phân công đào tạo và thu thập báo cáo. Điều này thường dựa trên các bộ phận và nhóm, hoặc các khu vực. Chúng tôi khuyến nghị tạo nhóm trước khi tạo người dùng để bạn có thể gán người dùng trực tiếp vào nhóm ngay khi tạo. Xem tại đây để biết thêm thông tin về cấu trúc nhóm.
   
• Vị trí của người dùng cho phép bạn phân công đào tạo dựa trên vai trò của họ trong tổ chức. Xem tại đây để biết thêm thông tin về các vị trí người dùng.
   
• Chúng tôi khuyến nghị thiết lập một môi trường thử nghiệm để kiểm tra các cuộc gọi và tích hợp của bạn một cách tổng thể trước khi chuyển sang môi trường sản xuất. Vui lòng liên hệ với Quản lý Thành công Khách hàng của bạn hoặc gửi email đến support@motimateapp.com để được hỗ trợ. 
   
• Giao diện lập trình ứng dụng (API) của Motimate được cung cấp dưới định dạng JSON. 

Tạo nhóm

Để tạo nhóm, hãy sử dụng lệnh sau:
POST https://motimateapp.com/public_api/groups

Thêm payload vào phần thân với thông tin cần thiết cùng với nhóm. Trường "parent_id" được sử dụng để tạo cấu trúc nhóm. Nhập ID của một nhóm khác vào trường này sẽ đặt nhóm đó làm nhóm cha.

Lưu ý: Cấp độ của nhóm phải nằm ở cấp độ thấp hơn so với nhóm cha, với "Cấp độ 1" là cấp độ cao nhất. Điều này cho phép bạn nhập cấu trúc nhóm vào tài khoản Motimate của mình. 

Cập nhật nhóm 

Để cập nhật một nhóm trong Motimate, bạn cần sử dụng lệnh sau. ID được sử dụng trong ví dụ này là ID nhóm Motimate. 

Bản vá https://motimateapp.com/public_api/groups/{group_id}

Thêm dữ liệu cần thiết vào phần thân (body) để cập nhật thông tin trên các nhóm. Điều này có thể được sử dụng khi cần di chuyển một Nhóm sang một cấp độ khác hoặc khi cần điều chỉnh cấu trúc. 

 

Xóa nhóm

Để xóa một nhóm trong Motimate, bạn cần thực hiện lệnh sau. ID được sử dụng trong ví dụ này là ID nhóm Motimate. Đặt giá trị lực thành '1' sẽ xóa vĩnh viễn bản ghi, không có cách nào khôi phục nhóm trong trường hợp này.

XÓA https://motimateapp.com/public_api/groups/{group_id}

Thực thi lệnh này sẽ xóa nhóm đã chọn, mặc dù không có phản hồi được trả về:

 

Tạo người dùng

Để tạo người dùng, hãy sử dụng lệnh sau: 

ĐĂNG https://motimateapp.com/public_api/users

Thêm payload vào phần thân (body) với các thông tin cần thiết của người dùng. Địa chỉ email hoặc số điện thoại sẽ là trường thông tin bắt buộc tùy thuộc vào cài đặt tài khoản Motimate của bạn. Bạn có thể chọn các nhóm của người dùng bằng cách sử dụng trường gán nhóm. Nhập ID nhóm mà bạn muốn người dùng tham gia và vai trò của họ trong nhóm (thành viên, quản trị viên hoặc người quan sát). Chúng tôi khuyến nghị đặt assing_ancestors thành 'true' trong hầu hết các trường hợp. Điều này đảm bảo rằng người dùng sẽ là thành viên của các nhóm cha của các nhóm được phân công cho họ. 

 

Cập nhật thông tin người dùng

Để cập nhật thông tin của người dùng trong Motimate, bạn cần thực hiện cuộc gọi sau. ID được sử dụng trong ví dụ này là ID người dùng Motimate. 

Bản vá https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

Thêm dữ liệu cần thiết vào phần thân (body) với chỉ những thông tin cần thiết mà bạn muốn cập nhật cho người dùng.

 

Xóa người dùng

Để xóa một người dùng trong Motimate, bạn cần thực hiện lệnh sau. ID được sử dụng trong ví dụ này là ID người dùng Motimate. Đặt giá trị lực thành '1' sẽ xóa vĩnh viễn bản ghi, không có cách nào khôi phục nhóm trong trường hợp này. Đặt giá trị thành '0' sẽ xóa mềm bản ghi, cho phép khôi phục lại nếu cần thiết. 

XÓA https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id

Thực thi lệnh này sẽ xóa người dùng đã chọn, mặc dù không có phản hồi được trả về: 

Khôi phục người dùng

Đôi khi một tài khoản người dùng bị xóa nhầm và cần được khôi phục. Nếu các mục đã bị xóa mềm (soft delete) chứ không phải xóa vĩnh viễn (hard destroy), việc này có thể thực hiện bằng cách gọi hàm sau. ID được sử dụng trong ví dụ này là ID người dùng Motimate. 

Bản vá https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id