Adobe Captivate Prime bulut tabanlı, öğrenci merkezli bir self servis Öğrenme Yönetimi Çözümüdür. Prime API, Prime'da bulunan kaynaklara erişim vererek müşterilerin iş akışlarını sorunsuz uygulamak için Prime'ı genişletebilmesine ve kullandıkları diğer kurumsal uygulamalarla entegre etmesine imkan tanıyan program erişimi sağlar. API, Adobe iş ortakları tarafından da kullanılarak, işlevi genişletmek veya diğer popüler uygulamalar ya da servislerle entegrasyon sağlamak yoluyla Prime'ın değer teklifini geliştirebilir.
Prime API, REST'in mimari prensiplerine dayalıdır ve Kullanıcı, Ders, Eğitim Planı ve Kayıt gibi Prime nesne modelinin anahtar öğelerini kaynak olarak sunar. Tüm API istekleri, belirli bir Prime hesabına erişmek için kimlik doğrulaması yapılan belirli bir kullanıcı bağlamında yapılır. Bu sayede kullanıcı, sadece bu hesaptaki verilere erişebilir ve bu da kullanıcının rol ve izinlerine bağlıdır.
Sürüm 1'de Prime API büyük ölçüde kaynakların çoğuna GET erişimi sağlamaya odaklıdır. Uç noktaların ve yöntemlerin kapsamlı ve tam listesini almak için API dokümanlarına bakabilirsiniz. Prime, çok sayıda nesne türü (kaynak) ve iç ilişkileri bulunan çok zengin bir veri modeline sahiptir ve bu nedenle, yandan yüklemeye ve API yanıtlarının polimorfik olmasına imkan tanıyan JSONAPI v1.0 standardına uymayı tercih ettik.
Prime API'yi kullanarak geliştiriciler, Prime'ın işlevini genişleten ve diğer kurumsal uygulamaları içeren belirli iş akışları bağlamına Prime'ı entegre eden kendi kendine yeterli uygulamalar geliştirebilir. Geliştirdiğiniz uygulama genellikle Prime platformunun dışına yüklenir (bir web uygulaması, masaüstü uygulaması, mobil uygulama olabilir) ve geliştiricinin, kullanım süresince bu uygulamanın yönetimi üzerinde tam denetimi bulunur. Genellikle uygulamalar bir müşteri kuruluşu tarafından Prime hesabıyla birlikte kullanım için geliştirilir ve bu uygulamalar, müşteri kuruluşuna “özgüdür”. Ancak Adobe iş ortakları, çok sayıda Prime müşterisinin “ortak” ilgisine hitap eden genel uygulamalar geliştirmek için de Prime API'yi kullanabilir.
Sonraki bölümde Prime API ile ilgili üst düzey bir kısa özet sağlanmakta ve örnek uygulama kodu incelenmektedir. Bu belgenin devamında, geliştiricilerin uygulamaları için anahtarları nasıl alabileceğine ve yönetebileceğine ve Prime hesapları tarafından uygulamalara nasıl güvenileceğine odaklanılmaktadır. Çeşitli API uç noktalarının ve yöntemlerinin ayrıntıları için API dokümanlarına bakabilirsiniz.
Prime API
Prime API, REST'in prensiplerine dayalıdır ve HTTP üzerinden uygulama geliştiricilerine Prime Nesne Modelinin temel öğelerini göstermektedir. API uç noktalarının ve HTTP yöntemlerinin ayrıntılarına girmeden önce geliştiriciler, öncelikle çeşitli Prime nesneleri, özellikleri ve ilişkileri hakkında bilgi edinmeyi faydalı bulabilir. Modeller iyi anlaşıldıktan sonra API isteklerinin ve yanıtlarının yapısıyla ve API'de genel olarak desteklediğimiz birkaç yaygın programlama ifadesiyle ilgili temel bir bilgiye sahip olmak faydalı olacaktır. Son olarak bu bölümde basit bir örneğin kodu incelenmektedir.
Prime Modelleri
Prime API, geliştiricilerin RESTful kaynaklar gibi Prime nesnelerine erişimine imkan tanır. Temel olarak bu, her bir API uç noktasının bir kaynağı (tipik olarak rozet gibi bir nesne veya bu nesnelerin bir koleksiyonu) temsil ettiğini belirtir. Ardından geliştiriciler, bu nesneler (koleksiyonlarda) CRUD işlemlerini gerçekleştirmek için PUT, GET, POST ve DELETE gibi HTTP fiillerini kullanır.
Aşağıdaki tabloda, Prime Object Modelinin çeşitli öğeleri yer almaktadır:
Uygulama Geliştirme Süreci
Geliştirme ve Test
Geliştirici hesabı alma
Geliştiricilerin öncelikle Prime'da bir deneme hesabı oluşturarak, bu hesaptan tüm rollere tam erişime sahip olması önerilir. Bir uygulama yazabilmek için geliştiricinin bazı kullanıcılar ve dersler oluşturması ve geliştirilen uygulamanın bazı dolgu verilere erişim sağlayabilmesi için hesabı makul bir duruma getirmesi gerekir
İstemci kodu ve gizli anahtar oluşturma
Entegrasyon Yöneticisi rolüne nasıl geçebileceğinizi ve yeni uygulamayı nasıl kaydedeceğinizi açıklayın. Ekran görüntüsünü gösterin ve çeşitli alanları açıklayın.
Uygulamayı geliştirme ve test etme
Prime API, geliştirici tarafından herhangi bir tür uygulama geliştirmek için kullanılabilir. Geliştirme sırasında geliştiricinin, deneme hesapta bazı kullanıcıların ve derslerin bulunduğunu kontrol etmesi gerekir. Geliştiricinin en az bir kaç deneme kullanıcısı ve deneme dersi oluşturarak etkinliği deneme hesapta simüle etmesi ve uygulama işlevini test etmesi daha faydalı olacaktır.
