Motimate: Kullanıcıları ve grupları sağlamak ve yönetmek için genel API nasıl kullanılır?
Kaynak sisteminizi REST API'mize bağlayarak Motimate'te kullanıcı sağlayabilir ve yönetebilirsiniz. Bu, Motimate'te kullanıcı oluşturma, kullanıcıları güncelleme, kullanıcıları silme, gruplar oluşturma ve kullanıcıları doğru gruplara sağlama gibi çeşitli temel işleri gerçekleştirmenize olanak tanır.
Motimate Public API hakkında genel bilgi ve onu kullanmaya nasıl başlayacağınız için, lütfen buraya bakın.
Arka plan bilgisi:
- Tüm kullanıcılar ve gruplar, API ile kullanılabilen benzersiz Motimate ID'lerine sahiptir, ancak API ile kullanabileceğiniz bir 'harici ID' de tanımlayabilirsiniz. Bu 'harici kimlik' genellikle kendi veri kaynağınızda söz konusu kullanıcı veya grup için sahip olduğunuz kimlikle eşleşecek şekilde ayarlanır.
- Gruplar bir hiyerarşi veya grup ağacı oluşturmak için kullanılır. Bu genellikle organizasyon yapınızı yakından yansıtacaktır ve eğitimi delege etmek ve rapor almak için kullanılır. Bu genellikle departmanlara ve ekiplere ya da bölgelere dayanmaktadır. Kullanıcıları oluşturduktan sonra doğrudan gruplara atayabilmeniz için kullanıcıları oluşturmadan önce grupları oluşturmanızı öneririz. Grup yapısı hakkında daha fazla bilgi için buraya bakın.
- Bir kullanıcının Pozisyonu, kuruluştaki rolüne göre eğitim delegasyonu yapmanıza olanak tanır. Kullanıcı Pozisyonları hakkında daha fazla bilgi için buraya bakın.
- Üretim ortamınıza aktarmadan önce çağrılarınızı ve entegrasyonunuzu bir bütün olarak test etmek için bir test ortamı kurmanızı öneririz. Yardım için lütfen Müşteri Başarı Yöneticinizle veya support@motimateapp.com adresiyle iletişime geçin.
- Motimate'in API'si JSON biçimindedir.
Grup oluşturma
Grup oluşturmak için aşağıdaki çağrıyı kullanın:
POST https://motimateapp.com/public_api/groups
Grup ile birlikte gerekli bilgileri içeren payload'u gövdeye ekleyin. "parent_id" alanı bir grup yapısı oluşturmak için kullanılır. Bu alana farklı bir grubun kimliğinin girilmesi, o grubu üst grup olarak ayarlayacaktır.
Lütfen dikkat: grubun seviyesi ana gruptan daha alt hiyerarşide olmalıdır, "Seviye 1" en yüksek seviyedir. Bu, grup yapılarını Motimate hesabınıza aktarmanıza olanak tanır.
Grupları güncelleme
Motimate'te bir grubu güncellemek için aşağıdaki çağrıya ihtiyacınız olacaktır. Bu örnekte kullanılan kimlik Motimate grup kimliğidir.
YAMA https://motimateapp.com/public_api/groups/{group_id}
Gruplar üzerinde güncellemek istediğiniz gerekli verilerle birlikte gövdeye yük ekleyin. Bu, bir Grubun farklı bir seviyeye taşınması veya yapının ayarlanması gerektiğinde kullanılabilir.
Grupları silme
Motimate'te bir grubu silmek için aşağıdaki çağrıya ihtiyacınız olacaktır. Bu örnekte kullanılan kimlik Motimate grup kimliğidir. Kuvveti ´1´ olarak ayarlamak kaydı sert bir şekilde yok edecektir, bu senaryoda grubu kurtarmanın bir yolu yoktur.
SİL https://motimateapp.com/public_api/groups/{group_id}
Bu çağrıyı çalıştırmak, bir yanıt döndürülmese de seçilen grubu silecektir:
Kullanıcı Oluşturma
Kullanıcı oluşturmak için aşağıdaki çağrıyı kullanın:
POSTA https://motimateapp.com/public_api/users
Kullanıcının gerekli bilgileriyle birlikte payload'u gövdeye ekleyin. Motimate hesap ayarlarınıza bağlı olarak e-posta adresi veya telefon numarası zorunlu bir alan olacaktır. Grup atamaları alanını kullanarak kullanıcının Gruplarını seçebilirsiniz. Kullanıcının bir parçası olmasını istediğiniz Grup kimliğini ve gruptaki rolünü (üye, yönetici veya gözlemci) girin. Senaryoların büyük çoğunluğunda assing_ancestors öğesini 'true' olarak ayarlamanızı öneririz. Bu, kullanıcıların atandıkları grupların üst gruplarına üye olmalarını sağlar.
Kullanıcıları Güncelleme
Motimate'te bir kullanıcının bilgilerini güncellemek için aşağıdaki çağrıya ihtiyacınız olacaktır. Bu örnekte kullanılan kimlik Motimate kullanıcı kimliğidir.
YAMA https://motimateapp.com/public_api/users/{user_id}?identifier_type=id
Gövdeye yalnızca kullanıcı için güncellemek istediğiniz gerekli verileri içeren bir yük ekleyin.
Kullanıcıları Silme
Motimate'te bir kullanıcıyı silmek için aşağıdaki çağrıya ihtiyacınız olacaktır. Bu örnekte kullanılan kimlik Motimate kullanıcı kimliğidir. Kuvveti ´1´ olarak ayarlamak kaydı sert bir şekilde yok edecektir, bu senaryoda grubu kurtarmanın bir yolu yoktur. Bunu ´0´ olarak ayarlamak kaydı yumuşak bir şekilde siler ve gerekirse kurtarılmasına izin verir.
SİL https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id
Bu çağrıyı çalıştırmak, bir yanıt döndürülmese de seçilen kullanıcıyı silecektir:
Kullanıcıları Geri Yükleme
Bazen bir kullanıcı yanlışlıkla silinir ve geri yüklenmesi gerekir. Eğer yumuşak bir şekilde silinmişlerse ve sert bir şekilde yok edilmemişlerse, bu işlem aşağıdaki çağrı ile yapılabilir. Bu örnekte kullanılan kimlik Motimate kullanıcı kimliğidir.
YAMA https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id
0 yorum
Yorum yazmak için lütfen oturum açın: oturum aç.