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

API to skrót od Application Programming Interface. Jest to interfejs, który pozwala aplikacjom komunikować się ze sobą. Zasadniczo pozwala zażądać czegoś lub zadać pytanie, po czym wywołanie API wykonuje akcję, którą ma wykonać, po dostarczeniu mu informacji.

Wyobraź sobie, że siedzisz przy stoliku w restauracji z menu do wyboru. Kuchnia jest częścią "systemu", która przygotuje twoje zamówienie. Brakuje jednak krytycznego ogniwa, które przekaże zamówienie do kuchni i dostarczy jedzenie z powrotem do stolika. W tym miejscu pojawia się kelner lub API. Kelner jest posłańcem - lub API - który przyjmuje twoje żądanie lub zamówienie i mówi kuchni - systemowi - co ma robić. Następnie kelner dostarcza odpowiedź z powrotem do użytkownika; w tym przypadku jest to jedzenie.

Podsumowując, gdy firma oferuje API swoim klientom, oznacza to po prostu, że zbudowała zestaw dedykowanych adresów URL, które zwracają czyste dane - co oznacza, że odpowiedzi nie będą zawierały tego rodzaju narzutu prezentacyjnego, jakiego można oczekiwać w graficznym interfejsie użytkownika, takim jak strona internetowa.

Mamy pięć wywołań API, które pełnią różne funkcje.

Wywołanie API składa się z trzech elementów:

Ładunek to informacje wysyłane do punktu końcowego, czyli dane wymagane do dodania uczestnika.

Punkt końcowy to adres internetowy, na który wysyłane są informacje, a odpowiedź wskazuje, czy wywołanie API powiodło się, czy nie.

Webhooków można używać w połączeniu z wywołaniami API w celu inicjowania różnych działań. Po wysłaniu elementu webhook zawierającego ładunek wymagany do działania określonego wywołania API, wywołanie API wykona swoją pracę i doda uczestnika. Webhooki muszą być wysyłane z Twojego systemu do naszego punktu końcowego i muszą być skonfigurowane samodzielnie w Twoim systemie.

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

Menedżer HR stworzył kurs i egzaminy dla nowo zatrudnionych pracowników. Menedżer HR chce, aby pracownicy wzięli udział w kursie, ale chce, aby uzyskali dostęp do egzaminu dopiero po ukończeniu kursu. Dopiero po zdaniu egzaminu chcą, aby pracownicy mieli dostęp do akademii, która zawiera kursy i egzaminy na poziomie średniozaawansowanym i eksperckim. Jak więc to skonfigurować?

Aby zrozumieć, jak to skonfigurować, ustaliliśmy już, że te webhooki i wywołania API będą wysyłane wewnętrznie w systemie Easy LMS. Proces wygląda następująco.

Menedżer HR musi utworzyć webhook, który wysyła ładunek do interfejsu API Egzaminu po ukończeniu kursu przez pracownika. Ten webhook musi zawierać tylko dane potrzebne do wywołania API egzaminu. W tym przypadku używamy wywołania API Add participant to Egzamin (invite). Gdy ten webhook zostanie wysłany, wywołanie API zostanie wyzwolone, jeśli odpowiedź będzie pomyślna. Wywołanie API doda uczestnika i automatycznie wyśle zaproszenie na Egzamin.

Drugi webhook menedżer HR musi utworzyć, gdy pracownik pomyślnie zda egzaminy, aby uzyskać dostęp do akademii. Ponownie, ładunek tego webhooka powinien zawierać tylko informacje potrzebne wywołaniu API akademii do dodania uczestnika i wysłania zaproszenia. Po wysłaniu tego webhooka wywołanie API akademii zostanie uruchomione, po czym doda uczestnika do akademii i wyśle zaproszenie.

Podsumowując:

Klient chce wykorzystać nasze narzędzie do szkolenia swoich (nowych) pracowników. Obecnie używa ustawienia predefiniowanej grupy uczestników do wysyłania e-maili z zaproszeniami. Jednak wielu pracowników postrzega te zaproszenia jako spam, a niektóre z tych wiadomości trafiają również do folderów spamu. Klient chce zamiast tego wysyłać te zaproszenia z własnego systemu.

Klient najpierw tworzy webhook, który wysyła payload do API Egzaminu - dodaj uczestnika bez powiadamiania. Po dodaniu nowego pracownika do systemu, webhook wysyła ładunek do API Egzaminu, które dodaje pracownika. Wywołanie API nie wysyła zaproszenia do tego pracownika. Gdy wywołanie API powiedzie się, odpowiedź zawiera dane logowania. Te dane logowania należy następnie wysłać do pracownika z własnego systemu i aplikacji pocztowej.

Działa to również w przypadku istniejących pracowników, wystarczy utworzyć webhook, który wysyła ładunek do interfejsu API Egzaminu, który uruchamia akcję dodawania uczestników bez powiadamiania o egzaminie. Dane logowania zwrócone w odpowiedzi na wywołanie API można następnie wysłać z własnego systemu.

Klient tworzy egzaminy w naszym systemie i sprzedaje je swoim klientom ze swojej witryny e-commerce. Chce to zautomatyzować po tym, jak klienci zapłacą za egzaminy.

Aby zautomatyzować proces sprzedaży, będą musieli użyć webhooka. Kiedy ich klienci kupują lub płacą za egzamin na swojej stronie e-commerce, są dodawani do ich systemu. Utworzony przez nich webhook musi zostać uruchomiony po dokonaniu płatności. Ten webhook wyśle następnie odpowiedni ładunek do wywołania API Egzaminu i musi zwrócić odpowiedź o powodzeniu lub błędzie. Jeśli odpowiedź jest pomyślna, wywołanie API dodaje i zaprasza klientów do egzaminu, za który zapłacili.
​

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

Dowiedz się więcej w następujących artykułach: