Memotivasi: Bagaimana cara menggunakan API publik untuk menyediakan dan mengelola pengguna dan grup?

Anda dapat menyediakan dan mengelola pengguna di Motimate dengan menghubungkan sistem sumber Anda ke REST API kami. Hal ini memungkinkan Anda untuk menangani beberapa pekerjaan inti di Motimate seperti membuat pengguna, memperbarui pengguna, menghapus pengguna, membuat grup, dan menyediakan pengguna ke grup yang tepat. 

Informasi latar belakang: 

• Semua pengguna dan grup memiliki ID Motimate unik yang dapat digunakan dengan API, tetapi Anda juga dapat menentukan 'ID eksternal' yang dapat digunakan dengan API. 'ID eksternal' ini biasanya diatur agar sesuai dengan ID yang Anda miliki untuk pengguna atau grup tersebut di sumber data Anda. 
   
• Grup digunakan untuk membuat hierarki atau pohon kelompok. Ini biasanya akan sangat mirip dengan struktur organisasi Anda, dan digunakan untuk mendelegasikan pelatihan dan mendapatkan laporan. Hal ini sering kali didasarkan pada departemen dan tim, atau wilayah. Kami menyarankan untuk membuat grup sebelum membuat pengguna agar Anda dapat menetapkan pengguna secara langsung ke grup setelah pembuatan. Lihat di sini untuk informasi lebih lanjut tentang struktur grup.
   
• Posisi pengguna memungkinkan Anda mendelegasikan pelatihan berdasarkan peran mereka di organisasi. Lihat di sini untuk informasi lebih lanjut tentang Posisi pengguna.
   
• Kami menyarankan untuk menyiapkan lingkungan uji coba untuk menguji panggilan dan integrasi Anda secara keseluruhan, sebelum mentransfer ke lingkungan produksi. Silakan hubungi Manajer Kesuksesan Pelanggan Anda atau support@motimateapp.com untuk mendapatkan bantuan. 
   
• API Motimate dalam format JSON. 

Membuat grup

Untuk membuat grup, gunakan panggilan berikut:
POST https://motimateapp.com/public_api/groups

Tambahkan muatan ke badan dengan informasi yang diperlukan bersama grup. Bidang "parent_id" digunakan untuk membuat struktur grup. Memasukkan ID grup yang berbeda di bidang ini akan menetapkan grup tersebut sebagai induk.

Harap diperhatikan: level grup harus berada pada hierarki yang lebih rendah dari grup induk, dengan "Level 1" sebagai level tertinggi. Hal ini memungkinkan Anda untuk mengimpor struktur grup ke dalam akun Motimate Anda. 

Memperbarui grup 

Untuk memperbarui grup di Motimate, Anda perlu melakukan panggilan berikut. Id yang digunakan dalam contoh ini adalah id grup Motimate. 

PATCH https://motimateapp.com/public_api/groups/{group_id}

Tambahkan muatan ke badan dengan data yang diperlukan yang ingin Anda perbarui di Grup. Ini dapat digunakan ketika Grup perlu dipindahkan ke tingkat yang berbeda atau jika strukturnya perlu disesuaikan. 

 

Menghapus grup

Untuk menghapus grup di Motimate, Anda perlu melakukan panggilan berikut. Id yang digunakan dalam contoh ini adalah id grup Motimate. Mengatur force ke ´1´ akan menghancurkan rekaman dengan keras, tidak ada cara untuk memulihkan grup dalam skenario ini.

MENGHAPUS https://motimateapp.com/public_api/groups/{group_id}

Menjalankan panggilan ini akan menghapus grup yang dipilih, meskipun tidak ada respons yang diberikan:

 

Membuat Pengguna

Untuk membuat pengguna, gunakan panggilan berikut: 

POST https://motimateapp.com/public_api/users

Tambahkan muatan ke badan dengan informasi yang diperlukan pengguna. Alamat email atau nomor telepon akan menjadi bidang wajib tergantung pada pengaturan akun Motimate Anda. Anda dapat memilih Grup pengguna dengan menggunakan bidang penugasan grup. Masukkan id Grup yang Anda inginkan agar pengguna menjadi bagian dari grup tersebut dan perannya dalam grup (anggota, admin, atau pengamat). Kami merekomendasikan pengaturan assing_ancestors ke 'true' dalam sebagian besar skenario. Hal ini memastikan bahwa pengguna akan menjadi anggota grup induk dari grup yang ditugaskan kepada mereka. 

 

Memperbarui Pengguna

Untuk memperbarui informasi pengguna di Motimate, Anda perlu melakukan panggilan berikut. Id yang digunakan dalam contoh ini adalah id pengguna Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

Tambahkan muatan ke badan dengan hanya data yang diperlukan yang ingin Anda perbarui untuk pengguna.

 

Menghapus Pengguna

Untuk menghapus pengguna di Motimate, Anda perlu melakukan panggilan berikut ini. Id yang digunakan dalam contoh ini adalah id pengguna Motimate. Mengatur force ke ´1´ akan menghancurkan rekaman dengan keras, tidak ada cara untuk memulihkan grup dalam skenario ini. Mengaturnya ke ´0´ akan menghapus catatan secara lembut, sehingga memungkinkannya untuk dipulihkan jika perlu. 

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

Menjalankan panggilan ini akan menghapus pengguna yang dipilih, meskipun tidak ada respons yang diberikan: 

Memulihkan Pengguna

Terkadang pengguna terhapus secara tidak sengaja dan perlu dipulihkan. Jika mereka telah dihapus secara lunak, dan tidak dihancurkan secara keras, hal ini dapat dilakukan dengan panggilan berikut. Id yang digunakan dalam contoh ini adalah id pengguna Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id