Motimate: Bagaimana cara menggunakan API Publik Motimate?
Gunakan API Publik untuk mengotomatiskan integrasi dan sinkronisasi pengguna dengan sumber data Anda, dan hubungkan Motimate ke layanan keren lainnya 🔀
API Publik v2 sekarang tersedia untuk semua pelanggan!
- Dokumentasi untuk PAPI v1 (Hanya untuk pelanggan lama - semua pelanggan baru akan mendapatkan v2)
- Dokumentasi untuk PAPI v2
API Publik adalah sekumpulan layanan yang dapat digunakan untuk memperbarui dan mengelola data di Motimate. Ini didokumentasikan dengan cara standar, yang disebut OpenAPI, dan menyediakan akses terprogram ke perangkat lunak kami sebagai layanan bagi para pengembang. API ini memiliki dukungan yang lebih luas daripada apa yang dapat Anda lakukan dengan SCIM dan CSV, tetapi Anda memerlukan layanan integrasi atau robot perangkat lunak untuk menggunakannya.
Peluncuran PAPI v2 membuatnya lebih mudah dari sebelumnya untuk mengekspor data dari MotiSpace Anda, dengan titik akhir seperti:
Harap dicatat:
- Anda perlu meminta kredensial API Anda dari Dukungan untuk mulai menggunakan layanan ini.
- Basis data API disegarkan secara berkala beberapa kali setiap jam.
Model Data
API Publik menyediakan model untuk mengotomatiskan penyediaan pengguna dan posting Pulse. Ia memiliki model data ini:
-
Model pengguna: Anda dapat menggunakan ini untuk membaca, menulis, dan memperbarui informasi pada akun pengguna. Hal ini dapat mencakup informasi kontak, peran akses, dan penugasan kelompok untuk manajemen moti. Jika pengguna memiliki satu atau beberapa posisi, ini juga dapat diatur di titik akhir ini.
-
Model grup: Ini memungkinkan Anda untuk membaca, menulis, dan menetapkan grup pengguna. Grup-grup ini juga dapat disusun dalam struktur pohon agar sesuai dengan organisasi Anda dan menyederhanakan tugas pembelajaran.
Penting: Tingkat grup saat ini ditentukan menggunakan jenis atribut. Nilai kebaikan dapat bervariasi dari satu organisasi ke organisasi lainnya. Ini juga dapat diubah dengan mudah oleh admin organisasi Anda. Saat menyiapkan integrasi API, disarankan untuk menentukan daftar nama jenis permanen untuk level grup Anda untuk menghindari potensi kesalahan dalam integrasi API jika nama jenis berubah.
-
Model posisi: Model ini memungkinkan Anda untuk membaca dan menulis posisi yang dapat ditetapkan akun pengguna.
-
Postingan: Anda dapat menggunakan ini untuk membuat postingan dan mempublikasikannya di Pulse. Hal ini bisa dilakukan dalam kombinasi dengan layanan file untuk mengunggah gambar.
-
File: Layanan ini digunakan untuk mengunggah gambar untuk Pulse Posts. Batas ukuran untuk gambar adalah 40 MB, video 100MB, dan dokumen 100 MB.
- Wawasan: Layanan ini digunakan untuk menghasilkan dan mendapatkan tautan ke laporan khusus. Templat laporan harus dibuat terlebih dahulu di platform Motimate menggunakan fitur 'Buat Laporan' di bawah 'Wawasan'.
Otentikasi
Titik akhir Token OAuth digunakan untuk membuat token akses. Dapatkan client_id dan client_secret Anda dengan menghubungi support@motimateapp.com.
Setelah Anda menerima rincian ini, token dapat dibuat secara terprogram atau melalui platform seperti Postman. Yang perlu Anda lakukan adalah mengirim panggilan API ke POST /oauth/token endpointdengan client_id dan kredensial client_secret yang Anda terima dari Dukungan Motimate sebagai badan JSON.
API akan merespons dengan token unik, yang akan berlaku selama 24 jam. Anda dapat menghasilkan token sebanyak yang Anda butuhkan. Token harus diteruskan ke header Otorisasi sebagai token Pembawa dalam permintaan Anda ke semua titik akhir lainnya ("Pembawa" + [token_anda]).
Contoh:"Pembawa eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Anda dapat menggunakan perintah GET /me endpoint digunakan untuk memverifikasi token akses. Ini berguna jika Anda memiliki keystore untuk menyimpan token akses Anda dan Anda ingin memverifikasi bahwa token tersebut berfungsi tanpa melakukan panggilan transaksional.
Cara menguji API:
Untuk menguji API, kami sarankan untuk menggunakan platform API seperti Postman. Anda dapat menemukan panduan tentang cara mengimpor dokumentasi API Motimate lengkap ke Koleksi Postman dan Insomnia di sini.
Anda harus membuat token akses API seperti yang dijelaskan di atas, dan kemudian memasukkan token ini sebagai token Bearer di tab Otorisasi di Postman. Anda kemudian dapat melanjutkan dan menguji API dan meninjau responsnya.
0 komentar
Harap masuk untuk memberikan komentar.