Motimate: วิธีใช้ API สาธารณะเพื่อจัดเตรียมและจัดการผู้ใช้และกลุ่ม?
คุณสามารถจัดเตรียมและจัดการผู้ใช้ใน Motimate ได้โดยการเชื่อมต่อระบบต้นทางของคุณกับ REST API ของเรา สิ่งนี้ช่วยให้คุณสามารถจัดการงานหลักหลายอย่างใน Motimate ได้ เช่น การสร้างผู้ใช้ การอัปเดตผู้ใช้ การลบผู้ใช้ การสร้างกลุ่ม และการกำหนดผู้ใช้ไปยังกลุ่มที่ถูกต้อง
สำหรับข้อมูลทั่วไปเกี่ยวกับ Motimate Public API และวิธีการเริ่มต้นใช้งาน กรุณาดูที่นี่.
ข้อมูลพื้นฐาน:
- ผู้ใช้และกลุ่มทั้งหมดมี Motimate ID เฉพาะตัวที่สามารถใช้กับ API ได้ แต่คุณยังสามารถกำหนด 'ID ภายนอก' ที่คุณสามารถใช้กับ API ได้เช่นกัน 'รหัสภายนอก' นี้โดยทั่วไปจะถูกตั้งค่าให้ตรงกับรหัสที่คุณมีสำหรับผู้ใช้หรือกลุ่มนั้นในแหล่งข้อมูลของคุณเอง
- กลุ่มถูกใช้เพื่อสร้างลำดับชั้นหรือโครงสร้างต้นไม้ของกลุ่ม สิ่งนี้มักจะสะท้อนโครงสร้างองค์กรของคุณอย่างใกล้ชิด และใช้เพื่อมอบหมายการฝึกอบรมและรับรายงาน สิ่งนี้มักขึ้นอยู่กับแผนกและทีม หรือภูมิภาค เราขอแนะนำให้สร้างกลุ่มก่อนสร้างผู้ใช้ เพื่อให้คุณสามารถกำหนดผู้ใช้ไปยังกลุ่มได้โดยตรงเมื่อสร้างผู้ใช้ ดูข้อมูลเพิ่มเติมเกี่ยวกับโครงสร้างกลุ่มได้ที่นี่
- ตำแหน่งของผู้ใช้ช่วยให้คุณสามารถมอบหมายการฝึกอบรมตามบทบาทของพวกเขาในองค์กรได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับตำแหน่งของผู้ใช้ได้ที่นี่
- เราขอแนะนำให้ตั้งค่าสภาพแวดล้อมทดสอบเพื่อทดสอบการโทรและการผสานรวมทั้งหมดของคุณ ก่อนที่จะย้ายไปยังสภาพแวดล้อมการผลิตของคุณ กรุณาติดต่อผู้จัดการความสำเร็จของลูกค้าของคุณหรือsupport@motimateapp.com สำหรับ ความช่วยเหลือ
- API ของ Motimate อยู่ในรูปแบบ JSON
การสร้างกลุ่ม
เพื่อสร้างกลุ่ม ให้ใช้คำสั่งต่อไปนี้:
POST https://motimateapp.com/public_api/groups
เพิ่มข้อมูลที่ต้องการไปยังเนื้อหาหลักพร้อมข้อมูลที่จำเป็นในกลุ่ม ฟิลด์ "parent_id" ใช้เพื่อสร้างโครงสร้างกลุ่ม การป้อนรหัสของกลุ่มอื่นในช่องนี้จะตั้งค่ากลุ่มนั้นเป็นกลุ่มหลัก
โปรดทราบ: ระดับของกลุ่มต้องอยู่ในลำดับชั้นต่ำกว่ากลุ่มหลัก โดย "ระดับ 1" เป็นระดับสูงสุด สิ่งนี้ช่วยให้คุณสามารถนำเข้ากลุ่มโครงสร้างเข้าสู่บัญชี Motimate ของคุณได้
การอัปเดตกลุ่ม
เพื่อทำการอัปเดตกลุ่มใน Motimate คุณจะต้องใช้คำสั่งต่อไปนี้ รหัสที่ใช้ในตัวอย่างนี้คือรหัสกลุ่มของ Motimate
แพตช์ https://motimateapp.com/public_api/groups/{group_id}
เพิ่มข้อมูลที่ต้องการลงในเนื้อหาพร้อมข้อมูลที่จำเป็นที่คุณต้องการอัปเดตในกลุ่ม สิ่งนี้สามารถใช้ได้เมื่อกลุ่มต้องการย้ายไปยังระดับอื่นหรือหากโครงสร้างจำเป็นต้องปรับเปลี่ยน
การลบกลุ่ม
เพื่อที่จะลบกลุ่มใน Motimate คุณจะต้องใช้คำสั่งต่อไปนี้ รหัสที่ใช้ในตัวอย่างนี้คือรหัสกลุ่มของ Motimate การตั้งค่าแรงเป็น '1' จะทำลายบันทึกอย่างถาวร ไม่สามารถกู้คืนกลุ่มได้ในสถานการณ์นี้
ลบ https://motimateapp.com/public_api/groups/{group_id}
การเรียกใช้คำสั่งนี้จะลบกลุ่มที่เลือกไว้ แม้ว่าจะไม่มีการตอบกลับ:
การสร้างผู้ใช้
เพื่อสร้างผู้ใช้ ให้ใช้คำสั่งต่อไปนี้:
โพสต์ https://motimateapp.com/public_api/users
เพิ่มข้อมูลที่ต้องการส่งไปยังส่วนเนื้อหาพร้อมข้อมูลที่จำเป็นของผู้ใช้ อีเมลหรือหมายเลขโทรศัพท์จะเป็นช่องที่จำเป็นต้องกรอก ขึ้นอยู่กับการตั้งค่าบัญชี Motimate ของคุณ คุณสามารถเลือกกลุ่มของผู้ใช้ได้โดยใช้ช่องกำหนดกลุ่ม กรุณากรอกรหัสกลุ่มที่คุณต้องการให้ผู้ใช้เป็นส่วนหนึ่ง และบทบาทของผู้ใช้ในกลุ่ม (สมาชิก, ผู้ดูแลระบบ, หรือผู้สังเกตการณ์) เราขอแนะนำให้ตั้งค่า assing_ancestors เป็น 'true' ในสถานการณ์ส่วนใหญ่ สิ่งนี้ช่วยให้มั่นใจว่าผู้ใช้จะเป็นสมาชิกของกลุ่มหลักที่กลุ่มที่พวกเขาได้รับมอบหมายอยู่ด้วย
การอัปเดตผู้ใช้
เพื่อทำการอัปเดตข้อมูลผู้ใช้ใน Motimate คุณจะต้องใช้การเรียกต่อไปนี้ รหัสที่ใช้ในตัวอย่างนี้คือรหัสผู้ใช้ Motimate
แพตช์ https://motimateapp.com/public_api/users/{user_id}?identifier_type=id
เพิ่มข้อมูลที่ต้องการอัปเดตให้กับผู้ใช้ในเนื้อหาโดยใช้ข้อมูลที่จำเป็นเท่านั้น
การลบผู้ใช้
เพื่อทำการลบผู้ใช้ใน Motimate คุณจะต้องใช้การเรียกดังต่อไปนี้ รหัสที่ใช้ในตัวอย่างนี้คือรหัสผู้ใช้ Motimate การตั้งค่าแรงเป็น '1' จะทำลายบันทึกอย่างถาวร ไม่สามารถกู้คืนกลุ่มได้ในสถานการณ์นี้ การตั้งค่าเป็น '0' จะเป็นการลบข้อมูลแบบถาวรชั่วคราว ทำให้สามารถกู้คืนได้หากจำเป็น
ลบ https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id
การเรียกใช้คำสั่งนี้จะลบผู้ใช้ที่เลือกไว้ แม้ว่าจะไม่มีการตอบกลับ:
การกู้คืนผู้ใช้
บางครั้งผู้ใช้ถูก삭제โดยไม่ได้ตั้งใจและต้องการให้กู้คืน หากพวกเขาถูกลบแบบอ่อน (soft deleted) และไม่ได้ถูกทำลายอย่างถาวร (hard destroyed) สามารถดำเนินการได้ด้วยการเรียกใช้คำสั่งต่อไปนี้ รหัสที่ใช้ในตัวอย่างนี้คือรหัสผู้ใช้ Motimate
แพตช์ https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id
0 ข้อคิดเห็น
โปรด ลงชื่อเข้าใช้ เพื่อแสดงข้อคิดเห็น