Ten artykuł jest również dostępny w:
Ten artykuł został przetłumaczony przy użyciu tłumaczenia maszynowego. Może zawierać błędy lub dziwnie brzmiące tłumaczenia. Mimo to uważamy, że warto go przeczytać w swoim ojczystym języku. Daj nam znać, czy ten artykuł okazał się pomocny, lub przekaż inne uwagi u dołu artykułu.

Tutaj wyjaśniamy wszystko o (naszym) API z kilkoma ładnymi przykładami, jak możesz go używać i dlaczego powinieneś go używać.

1. Co to jest API?

API oznacza Application Programming Interface. Jest to interfejs, który pozwala aplikacjom programowym komunikować się ze sobą. W zasadzie pozwala on na żądanie czegoś, lub zadawanie pytań, po których wywołanie API wykonuje akcję, którą ma wykonać, po tym jak dostarczysz mu informacji. W naszym przypadku byłaby to prośba o dodanie uczestnika do Egzaminu, Kursu lub Akademii, która wymaga konkretnych danych o uczestniku.

Przykład 1

Po przejściu do Facebooka w przeglądarce, żądanie wychodzi na zdalny serwer Facebooka. Gdy Twoja przeglądarka otrzyma odpowiedź, interpretuje kod i wyświetla stronę.

Dla przeglądarki, znanej również jako klient, serwer Facebook jest API. Oznacza to, że za każdym razem, gdy odwiedzasz stronę w sieci, wchodzisz w interakcję z jakimś API zdalnego serwera.

API nie jest tym samym, co zdalne - rather server , lecz częścią serwera, która odbiera zgłoszenia i wysyła odpowiedzi.

Przykład 2

Wyobraź sobie, że siedzisz przy stole w restauracji z menu do wyboru. Kuchnia jest częścią "systemu", który przygotuje Twoje zamówienie. Brakuje krytycznego ogniwa, które umożliwi przekazanie zamówienia do kuchni i dostarczenie jedzenia z powrotem do stołu. Tam właśnie wchodzi kelner lub API. Kelner jest posłańcem lub API, który odbiera Twoje zapytanie lub zamówienie i informuje kuchnię - system - co należy zrobić. Następnie kelner dostarcza Ci odpowiedź; w tym przypadku jest to jedzenie.

Podsumowując, kiedy firma oferuje API dla swoich klientów, to po prostu oznacza, że zbudowali zestaw dedykowanych adresów URL, które zwracają czyste dane responses - meaning odpowiedzi nie będą zawierać rodzaj prezentowania kosztów ogólnych, które można by oczekiwać w graficznym interfejsie użytkownika, jak strona internetowa.

2. Do czego go używam?

Deweloperzy mogą używać różnych API na różne sposoby do budowania różnych rzeczy. Dobrym przykładem jest Facebook; strona uruchomiła swoją platformę deweloperską F8 w maju i obecnie zawiera zdumiewające 10 900 aplikacji od niesławnych Scrabulous do komunikatorów i gier walki z jedzeniem.

Zaletą strony hosta jest to, że dostaje wiele nowych, fajnych funkcji za darmo, podczas gdy deweloperzy dostać się do promowania swojej pracy na stronie bardziej wysoki profil i budować na czyjejś pracy. Większość z tych aplikacji są budowane przez firmy z własną stroną internetową - często mniejszych firm z mniejszym ruchem, którzy korzystają z crossover. Flixster, na przykład, ma popularną aplikację na Facebooku, podobnie jak Last.fm i Flickr.

3. Jakie połączenia API posiada Easy LMS?

Easy LMS posiada pięć połączeń API, które pełnią różne funkcje:

Dodaj uczestnika do egzaminu . (zapraszam)
Dodaj uczestnika do egzaminu bez powiadamiania (bez zaproszenia)
Dodaj uczestnika do Kurs (zapraszam)
Dodaj uczestnika do Akademia (zapraszam)
Dodaj uczestnika do Akademii bez powiadamiania (bez zaproszenia)

API wywołuje Egzamin tylko wtedy, gdy dostęp jest ustawiony na . Wstępnie zdefiniowana grupa uczestników, lub dla kursu, który jest tylko na zaproszenie. Jest to oczywiste dla Akademii. Nie jest również możliwe użycie któregokolwiek z tych wezwań do tego samego Egzaminu, Kursu lub Akademii, gdy uczestnik został już do niej dodany. To dlatego, że celem tych wezwań API jest dodanie uczestników, więc jeśli zostały już dodane, wezwanie API nie działa.

Połączenie API składa się z trzech rzeczy:

Ładunek handlowy (rzeczywiste dane, które są przesyłane)
Punkt końcowy (adres, na który wysyłane są dane)
Reakcja (sukces lub reakcja na błąd)

Ładunek jest informacją, która jest wysyłana do punktu końcowego, co oznacza, że dane są wymagane, aby dodać uczestnika do Egzaminu, Kursu lub Akademii.

Punktem końcowym jest adres internetowy, na który wysyłana jest informacja, a odpowiedź wskazuje, czy wywołanie API było udane, czy nie.

4. Webhooks .

Webbooki mogą być używane w połączeniu z połączeniami API do inicjowania różnych działań. Gdy zostanie wysłany webhook, który zawiera wymagane obciążenie dla danego połączenia API do pracy, połączenie API wykona swoją pracę i doda uczestnika. Haki internetowe muszą być wysyłane z Twojego systemu do naszego punktu końcowego. Jest to coś, co musiałbyś skonfigurować sam w swoim systemie.

Przykład 1 - Kurs, Przykład, Akademia

Poniższe akapity są częścią fikcyjnego przypadku użycia, aby wyjaśnić, jak mogą współpracować ze sobą webbooki i API.

Menadżer ds. zasobów ludzkich stworzył kurs wstępny i egzamin dla nowo zatrudnionych pracowników. Kierownik działu kadr chce, aby pracownicy wzięli udział w kursie, ale dostęp do egzaminu mają dopiero po jego ukończeniu. Dopiero po zdaniu egzaminu chce, aby pracownicy mieli dostęp do Akademii, która zawiera kursy i egzaminy na poziomie średniozaawansowanym i zaawansowanym. Więc, jak oni to ustawiają?

Aby zrozumieć, jak to ustawić, ustaliliśmy już, że te webbooki i połączenia API będą wysyłane wewnętrznie w systemie Easy LMS. Proces ten jest następujący:

Kierownik działu kadr musi stworzyć hak internetowy, który po ukończeniu przez pracownika kursu wysyła ładunek do Exam API. Webhook ten musi zawierać jedynie dane potrzebne do uruchomienia wywołania Exam API. W tym przypadku korzystamy z serwisu Add participant to Exam (invite) API call. Po wysłaniu tego webhook'a, wezwanie API zostanie wyzwolone w przypadku pomyślnej odpowiedzi. Wezwanie API dodaje uczestnika i automatycznie wysyła zaproszenie do Egzaminu.

Drugi hak internetowy, który musi stworzyć kierownik działu kadr, jest przeznaczony do tego, aby pracownik zdał egzamin i uzyskał dostęp do Akademii. Ponownie, ten webhok powinien zawierać tylko te informacje, które są potrzebne do dodania uczestnika i wysłania zaproszenia do Akademii przez API. Po wysłaniu tego haka ''Egzamin zdany'' zostanie uruchomione wywołanie API Akademii, po czym doda uczestnika i wyśle zaproszenie do Akademii.

Podsumowując:

Utwórz webhook do ukończenia kursu, który jest wysyłany na wywołanie API egzaminu.
Stwórz webhook do zdania egzaminu, który jest wysyłany na wywołanie API Akademii.
Pracownik bierze udział w Kursie i kończy go.
Webhook for Course completion jest wysyłany na adres . Dodaj uczestnika do Egzaminu (zaproś) API call endpoint oraz dodaje i zaprasza uczestnika do Egzaminu.
Pracownik przystępuje do egzaminu i zdaje go.
Webhook for passing Exam jest wysyłany na adres . Dodaj uczestnika do Akademii (zaproś). Punkt końcowy wywołania API oraz dodaje i zaprasza uczestnika do Akademii.



Przykład 2 - Wysyłanie zaproszeń z własnego systemu

Klient chce wykorzystać nasze narzędzie do szkolenia swoich (nowych) pracowników. Obecnie korzysta on z serwisu . Wstępnie zdefiniowana grupa uczestników ustawia wysyłanie zaproszeń na e-maile. Jednak wielu pracowników postrzega te zaproszenia jako spam, a niektóre z nich trafiają również do ich folderów ze spamem. Klient chce zamiast tego wysyłać te zaproszenia z własnego systemu.

Klient najpierw tworzy webhook, który wysyła ładunek do Exam API - dodaj uczestnika bez powiadamiania. Po dodaniu nowego pracownika do systemu, webhook wysyła ładunek do Exam API, które dodaje pracownika. Wywołanie API nie wysyła zaproszenia do tego pracownika. Gdy wywołanie API zakończy się sukcesem, odpowiedź zawiera dane do logowania. Te dane do logowania muszą być następnie wysłane do pracownika z Twojego systemu i aplikacji pocztowej.

Działa to również w przypadku istniejących pracowników, wystarczy stworzyć hak internetowy, który wysyła ładunek do API egzaminu, który uruchamia akcję dodawania uczestników bez powiadamiania o tym fakcie egzaminu. Dane do logowania zwrócone w odpowiedzi na wywołanie API mogą być następnie przesłane z własnego systemu.

Przykład 3 - Sprzedaż egzaminów

Klient tworzy Egzaminy w naszym systemie i sprzedaje je swoim klientom z ich strony e-commerce. Chce to zautomatyzować po tym jak jego klienci zapłacą za Egzamin.

Aby zautomatyzować proces sprzedaży, będzie musiał użyć haka sieciowego. Kiedy jego klienci kupują lub płacą za Egzamin na jego stronie e-commerce, są oni dodawani do jego systemu. Stworzony przez niego hak internetowy musi zostać uruchomiony po dokonaniu płatności. Ten webhook wyśle odpowiedni ładunek pieniędzy na wywołanie API egzaminu i musi zwrócić albo a(n) sukces albo odpowiedź na błąd. Jeśli jest to odpowiedź pozytywna, wywołanie API dodaje i zaprasza swoich klientów do egzaminu, za który zapłacili.



5. Kiedy używamy każdego z połączeń API i jakie są ich specyfikacje?

Ponieważ każde wywołanie API ma inną funkcję, mogą one być użyte do osiągnięcia różnych rzeczy. Na przykład, Dodaj uczestnika do Egzaminu (zaproszenie) może być wykorzystane do dodania uczestnika i wysłania zaproszenia do Egzaminu automatycznie po aktywacji tego wyzwalacza.

Nasze API akceptuje aplikacje/x-www-form-urlencoded lub multipart/form-data i json.

Dowiedz się więcej o naszych połączeniach API Exam i Academy w ten artykuł.

Dowiedz się więcej na temat naszego połączenia API kursu w ten artykuł.
Czy ten artykuł był pomocny?
Anuluj
Dziękuję!