Motimate: วิธีใช้ Motimate Public API?
ใช้ Public API เพื่อทำให้การผสานรวมผู้ใช้และการซิงโครไนซ์กับแหล่งข้อมูลของคุณเป็นไปโดยอัตโนมัติ และเชื่อมต่อ Motimate กับบริการเจ๋งๆ อื่นๆ 🔀
Public API v2 พร้อมให้บริการแล้วสำหรับลูกค้าทุกท่าน!
- เอกสารประกอบสำหรับ PAPI v1 (เฉพาะลูกค้าเก่า - ลูกค้าใหม่ทุกท่านจะได้รับ v2)
- เอกสารประกอบสำหรับ PAPI v2
Public API คือชุดของบริการที่สามารถใช้เพื่ออัปเดตและจัดการข้อมูลใน Motimate มีการบันทึกไว้ในรูปแบบมาตรฐานที่เรียกว่า OpenAPI และให้โปรแกรมเมอร์สามารถเข้าถึงซอฟต์แวร์ของเราในรูปแบบบริการได้ API นี้มีการรองรับที่กว้างขวางกว่าสิ่งที่คุณสามารถทำได้ด้วย SCIM และ CSV แต่คุณจำเป็นต้องมีบริการการผสานรวมหรือซอฟต์แวร์โรบอทเพื่อใช้งาน
การเปิดตัว PAPI v2 ทำให้การส่งออกข้อมูลจาก MotiSpace ของคุณง่ายกว่าที่เคย ด้วยจุดเชื่อมต่อปลายทาง เช่น:
โปรดทราบ:
- คุณต้องขอข้อมูลประจำตัว API ของคุณจากฝ่ายสนับสนุนเพื่อเริ่มใช้บริการนี้
- ฐานข้อมูล API จะทำการรีเฟรชเป็นระยะ ๆหลายครั้งในแต่ละชั่วโมง
แบบจำลองข้อมูล
Public API ให้บริการโมเดลเพื่อทำให้การจัดการผู้ใช้และการโพสต์ Pulse เป็นไปโดยอัตโนมัติ มีโมเดลข้อมูลเหล่านี้:
-
โมเดลผู้ใช้:คุณสามารถใช้สิ่งนี้เพื่ออ่าน, เขียน, และอัปเดตข้อมูลบนบัญชีผู้ใช้ ซึ่งอาจรวมถึงข้อมูลติดต่อ บทบาทการเข้าถึง และการกำหนดกลุ่มสำหรับการจัดการแรงจูงใจ หากผู้ใช้มีตำแหน่งหนึ่งตำแหน่งหรือหลายตำแหน่ง ก็สามารถตั้งค่าได้ในจุดสิ้นสุดนี้เช่นกัน
-
กลุ่มแบบจำลอง: อนุญาตให้คุณอ่าน, เขียน, และกำหนดกลุ่มผู้ใช้. กลุ่มเหล่านี้สามารถจัดโครงสร้างเป็นโครงสร้างต้นไม้เพื่อให้สอดคล้องกับองค์กรของคุณและทำให้การมอบหมายงานเรียนรู้ง่ายขึ้น
สำคัญ: ระดับกลุ่ม ถูกกำหนดในปัจจุบันโดยใช้แอตทริบิวต์kind คุณค่าของความเมตตาอาจ แตกต่างกันไปในแต่ละองค์กร สามารถเปลี่ยนแปลงได้ง่ายโดยผู้ดูแลระบบขององค์กรของคุณ เมื่อตั้งค่าการผสานระบบ API แนะนำให้กำหนดรายการชื่อชนิด ถาวรสำหรับระดับกลุ่มของคุณเพื่อหลีกเลี่ยงข้อผิดพลาดที่อาจเกิดขึ้นในการผสานระบบ API หากชื่อชนิดมีการเปลี่ยนแปลง
-
โมเดลตำแหน่ง:โมเดลนี้ช่วยให้คุณสามารถอ่านและเขียนตำแหน่งที่บัญชีผู้ใช้สามารถถูกกำหนดได้
-
โพสต์:คุณสามารถใช้สิ่งนี้เพื่อสร้างโพสต์และเผยแพร่บน Pulse สามารถทำได้โดยใช้ร่วมกับบริการไฟล์เพื่ออัปโหลดรูปภาพ
-
ไฟล์:บริการนี้ใช้สำหรับอัปโหลดรูปภาพสำหรับโพสต์ Pulse ขนาดไฟล์รูปภาพสูงสุดคือ 40 MB, วิดีโอ 100MB, และเอกสาร 100 MB.
- ข้อมูลเชิงลึก:บริการนี้ใช้เพื่อสร้างและรับลิงก์ไปยังรายงานที่ปรับแต่งตามความต้องการ ต้องสร้างแม่แบบรายงานไว้ล่วงหน้าในแพลตฟอร์ม Motimate โดยใช้ฟีเจอร์ 'สร้างรายงาน' ภายใต้ 'ข้อมูลเชิงลึก'
การตรวจสอบสิทธิ์
จุดสิ้นสุด OAuth Token ใช้ เพื่อสร้างโทเค็นการเข้าถึง รับclient_idและclient_secretของคุณโดยติดต่อsupport@motimateapp.com
เมื่อคุณได้รับรายละเอียดเหล่านี้แล้ว สามารถสร้างโทเค็นได้ทางโปรแกรมหรือผ่านแพลตฟอร์มเช่นPostman สิ่งที่คุณต้องทำคือส่งคำขอ API ไปยัง POST /oauth/tokens จุดสิ้นสุด, โดยใช้ข้อมูลclient_idและclient_secretที่คุณได้รับจากฝ่ายสนับสนุนของ Motimate ในรูปแบบ JSON body.
API จะตอบกลับด้วยโทเค็นที่ไม่ซ้ำกัน ซึ่งจะมีอายุการใช้งาน 24 ชั่วโมง คุณสามารถสร้างโทเค็นได้มากเท่าที่คุณต้องการ โทเค็นควรถูกส่งไปยังส่วนหัว Authorization เป็น Bearer token ในการร้องขอของคุณไปยังเอนด์พอยต์อื่นๆ ทั้งหมด ("Bearer "+[your_token])
ตัวอย่าง:"ผู้ถือ eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
คุณสามารถใช้ GET /me endpoint ใช้เพื่อตรวจสอบโทเค็นการเข้าถึง นี่มีประโยชน์หากคุณมีคีย์สโตร์สำหรับเก็บโทเคนการเข้าถึงของคุณ และคุณต้องการตรวจสอบว่ามันทำงานอยู่หรือไม่โดยไม่ต้องทำการเรียกใช้การดำเนินการใด ๆ
วิธีทดสอบ API:
เพื่อทดสอบ API, เราขอแนะนำให้ใช้แพลตฟอร์ม API เช่นPostman. คุณสามารถหาคู่มือเกี่ยวกับวิธีการนำเข้าเอกสารประกอบการใช้งาน Motimate API ทั้งหมดไปยัง Postman และ Insomnia Collectionsได้ที่นี่
คุณควรสร้างโทเค็นการเข้าถึง API ของคุณตามที่อธิบายไว้ข้างต้น จากนั้นป้อนโทเค็นนี้เป็นโทเค็น Bearer ในแท็บ Authorization ภายใน Postman คุณสามารถดำเนินการทดสอบ API และตรวจสอบผลลัพธ์ได้
0 ข้อคิดเห็น
โปรด ลงชื่อเข้าใช้ เพื่อแสดงข้อคิดเห็น