Motimate: Motimate Public API nasıl kullanılır?
Veri kaynağınızla kullanıcı entegrasyonunu ve senkronizasyonunu otomatikleştirmek ve Motimate'i diğer harika hizmetlere bağlamak için Genel API'yi kullanın 🔀
Public API v2 artık tüm müşteriler için kullanılabilir!
- PAPI v1 için Dokümantasyon (Yalnızca eski - tüm yeni müşteriler v2 alacaktır)
- PAPI v2 için Dokümantasyon
Public API, Motimate'teki verileri güncellemek ve yönetmek için kullanılabilecek bir dizi hizmettir. OpenAPI adı verilen standart bir şekilde belgelenmiştir ve geliştiricilere yazılımımıza bir hizmet olarak programatik erişim sağlar. Bu API, SCIM ve CSV ile yapabileceğinizden daha geniş bir desteğe sahiptir, ancak bunu kullanmak için bir entegrasyon hizmetine veya yazılım robotuna ihtiyacınız vardır.
PAPI v2'nin piyasaya sürülmesi, aşağıdaki gibi uç noktalarla MotiSpace'inizden veri aktarmayı her zamankinden daha kolay hale getiriyor:
Lütfen unutmayın:
- Bu hizmeti kullanmaya başlamak için API kimlik bilgilerinizi Destek'ten talep etmeniz gerekir.
- API veritabanı her saat birkaç kez düzenli aralıklarla yenilenir.
Veri Modelleri
Genel API, kullanıcı sağlama ve Pulse gönderilerini otomatikleştirmek için modeller sağlar. Bu veri modellerine sahiptir:
-
Kullanıcı modeli: Kullanıcı hesaplarıyla ilgili bilgileri okumak, yazmak ve güncellemek için bunu kullanabilirsiniz. Bu, iletişim bilgilerini, erişim rollerini ve moti yönetimi için grup atamalarını içerebilir. Bir kullanıcının bir veya birden fazla pozisyonu varsa, bu da bu uç noktada ayarlanabilir.
-
Gruplar modeli: Bu, kullanıcı gruplarını okumanıza, yazmanıza ve atamanıza olanak tanır. Bu gruplar, kuruluşunuza uyacak ve öğrenme ödevlerini basitleştirecek şekilde bir ağaç yapısında da yapılandırılabilir.
Önemli: Grup seviyesi şu anda öznitelik türü kullanılarak tanımlanmaktadır. Türün değeri kuruluştan kuruluşa değişebilir. Ayrıca kuruluş yöneticiniz tarafından kolayca değiştirilebilir. API entegrasyonunu ayarlarken, tür adlarının değişmesi durumunda API entegrasyonunda olası hataları önlemek için grup düzeyleriniz için kalıcı bir tür adı listesi tanımlamanız önerilir.
-
Pozisyonlar modeli: Bu model, kullanıcı hesaplarının atanabileceği pozisyonları okumanıza ve yazmanıza olanak tanır.
-
Gönderiler: Gönderiler oluşturmak ve bunları Pulse'ta yayınlamak için bunu kullanabilirsiniz. Bu, resim yüklemek için dosya hizmetleri ile birlikte yapılabilir.
-
Dosyalar: Bu hizmet, Pulse Gönderileri için resim yüklemek için kullanılır. Resimler için boyut sınırı 40 MB, videolar için 100 MB ve belgeler için 100 MB'tır.
- İçgörüler: Bu hizmet, özelleştirilmiş bir rapor oluşturmak ve bu rapora bağlantı almak için kullanılır. Rapor şablonu, Motimate platformunda 'Insights' altındaki 'Generate Reports' özelliği kullanılarak önceden oluşturulmalıdır.
Kimlik Doğrulama
OAuth Token uç noktası , erişim belirteci oluşturmak için kullanılır. support@motimateapp.com ile iletişime geçerek client_id ve client_secret bilgilerinizi alın.
Bu ayrıntıları aldıktan sonra, tokenlar programlı olarak veya Postman gibi platformlar aracılığıyla oluşturulabilir. Tek yapmanız gereken şu adrese bir API çağrısı göndermektir POST /oauth/tokens uç noktasıMotimate Support'tan JSON gövdesi olarak aldığınız client_id ve client_secret kimlik bilgileriyle birlikte.
API, 24 saat boyunca geçerli olacak benzersiz bir belirteçle yanıt verecektir. İhtiyaç duyduğunuz kadar jeton üretebilirsiniz. Belirteç, diğer tüm uç noktalara yönelik isteklerinizde Yetkilendirme başlığına bir Taşıyıcı belirteci olarak aktarılmalıdır ("Taşıyıcı "+[your_token]).
Örnek:"Taşıyıcı eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Kullanabilirsiniz GET /me uç noktası erişim belirtecini doğrulamak için kullanılır. Bu, erişim belirtecinizi saklamak için bir anahtar deponuz varsa ve herhangi bir işlem çağrısı yapmadan çalıştığını doğrulamak istiyorsanız kullanışlıdır.
API nasıl test edilir?
API'yi test etmek için Postman gibi bir API platformu kullanmanızı öneririz. Motimate API belgelerinin tamamının Postman ve Insomnia Collections'a nasıl aktarılacağına ilişkin bir kılavuzu burada bulabilirsiniz.
API erişim belirtecinizi yukarıda açıklandığı gibi oluşturmalı ve ardından bu belirteci Postman içindeki Yetkilendirme sekmesinde bir Taşıyıcı belirteci olarak girmelisiniz. Daha sonra devam edip API'yi test edebilir ve yanıtları inceleyebilirsiniz.
0 yorum
Yorum yazmak için lütfen oturum açın: oturum aç.