Adobe Captivate Prime jest hostowanym w chmurze, samoobsługowym, zorientowanym na uczniów rozwiązaniem do zarządzania nauczaniem. API aplikacji Prime zapewnia dostęp do zasobów w celu zapewnienia programowego dostępu, tak aby klienci mogli rozszerzyć aplikację Prime i zintegrować ją z innymi stosowanymi aplikacjami korporacyjnymi w celu zapewnienia bezproblemowej pracy. Interfejs API może być również wykorzystywany przez partnerów Adobe w celu zwiększenia wartości aplikacji Prime poprzez zwiększenie liczby funkcji lub integrację z popularnymi aplikacjami lub usługami.
API aplikacji Prime opiera się na stylu architektonicznym REST i eksponuje kluczowe elementy modelu obiektowego Prime, takie jak Użytkownik, Kurs, Plan edukacyjny i Rejestracja jako zasoby. Wszystkie żądania API dotyczą konkretnego użytkownika, który został uwierzytelniony w celu uzyskania dostępu do konkretnego konta Prime. Dzięki temu użytkownik będzie mógł uzyskać dostęp tylko do danych w obrębie tego konta, a także do odpowiednich danych w oparciu o role i uprawnienia użytkownika.
W wersji 1 API Prime koncentruje się głównie na zapewnieniu dostępu GET do większości zasobów. Należy zapoznać się z dokumentacją API, aby uzyskać wyczerpującą i kompletną listę punktów końcowych i metod. Aplikacja Prime posiada bardzo bogaty model danych z wieloma typami obiektów (zasobów) i powiązaniami, dlatego też zastosowano specyfikację JSONAPI w wersji 1.0, która pozwala na ładowanie pośrednie i polimorficzne odpowiedzi API.
Korzystając z API Prime, programiści mogą tworzyć samodzielne aplikacje, które poszerzają funkcje Prime, a nawet integrują Prime w kontekście konkretnych procesów pracy z udziałem innych aplikacji korporacyjnych. Tworzona przez użytkownika aplikacja jest zazwyczaj wdrażana poza platformą Prime (może to być aplikacja internetowa, aplikacja komputerowa, aplikacja mobilna), a programista ma pełną kontrolę nad zarządzaniem tą aplikacją. Zazwyczaj aplikacje są opracowywane przez organizację klienta do stosowania z kontem Prime, i są to aplikacje „prywatne” dla tej konkretnej organizacji klienta. Jednakże partnerzy Adobe mogą również korzystać z interfejsu API Prime w celu tworzenia ogólnych aplikacji, które mogłyby być przedmiotem zainteresowania dużej grupy klientów Prime.
W następnej sekcji przedstawione zostaną ogólne informacje na temat interfejsu API Prime oraz przykładowych zastosowań. Reszta niniejszego dokumentu skupia się na sposobie, w jaki programiści mogą uzyskać i zarządzać kluczami do swoich aplikacji oraz co sprawia, że aplikacje mogą być stosowane przez konta Prime. Szczegółowe informacje na temat różnych punktów końcowych i metod API znajdują się w dokumentacji API.
Interfejs API Prime
API aplikacji Prime opiera się na zasadach REST i eksponuje kluczowe elementy modelu obiektowego Prime programistom aplikacji poprzez protokół HTTP. Przed zapoznaniem się z informacjami szczegółowymi dotyczącymi punktów końcowych API i metod HTTP programiści mogą uznać za przydatne zaznajomienie się z różnymi obiektami Prime, ich atrybutami i wzajemnymi powiązaniami. Gdy modele zostaną dobrze zrozumiane, przydatne będzie zapoznanie się ze strukturą żądań i odpowiedzi API oraz kilku idiomów programistycznych, które obsługujemy ogólnie w całym API. Ta sekcja kończy się prezentacją prostego kodu.
Modele Prime
Interfejs API Prime umożliwia programistom dostęp do obiektów Prime jako zasobów RESTful. Oznacza to, że każdy punkt końcowy API reprezentuje zasób (zazwyczaj instancję obiektu, taką jak Odznaka lub zbiór takich obiektów). Następnie programiści używają czasowników HTTP, takich jak PUT, GET, POST i DELETE do wykonywania operacji CRUD na tych obiektach (kolekcjach).
Poniższa tabela przedstawia różne elementy modelu obiektowego Prime
Proces opracowywania aplikacji
Rozwój i testowanie
Zakładanie konta programisty
Zaleca się, aby programista najpierw utworzył konto testowe, aby uzyskać pełny dostęp do wszystkich ról w ramach tego konta. Aby napisać aplikację, programista musi również utworzyć kilku użytkowników i kilka kursów oraz doprowadzić konto do odpowiedniego stanu, tak aby tworzona aplikacja miała dostęp do danych fikcyjnych.
Tworzenie identyfikatora klienta i tajnego klucza
Wyjaśnij, jak przełączyć się na rolę Administratora ds. integracji i zarejestrować nową aplikację. Pokaż zrzut ekranu i objaśnij znaczenie różnych pól
Opracowywanie i testowanie aplikacji
Interfejs API Prime może być wykorzystywany przez programistę do budowy dowolnego rodzaju aplikacji. Podczas tworzenia aplikacji programista będzie musiał się upewnić, że do konta testowego przypisano kilku użytkowników i kilka kursów. Zaleca się, aby programista utworzył co najmniej kilku fikcyjnych użytkowników i kursów oraz symulował aktywność na koncie testowym, tak aby przetestować działanie aplikacji.
