W tym miejscu wyjaśniamy wszystko na temat (naszego) API, podając kilka ciekawych przykładów, jak z niego korzystać i dlaczego warto to robić.

API to skrót od Application Programming Interface (interfejs programowania aplikacji). Jest to interfejs umożliwiający komunikację między aplikacjami. Zasadniczo pozwala on na wysłanie żądania lub zadanie pytania, po czym wywołanie API wykonuje przewidzianą czynność na podstawie dostarczonych informacji.

Wyobraź sobie, że siedzisz przy stoliku w restauracji z menu, z którego możesz wybrać dania do zamówienia. Kuchnia to część „systemu”, która przygotuje Twoje zamówienie. Brakuje jednak kluczowego ogniwa, które przekaże Twoje zamówienie do kuchni i dostarczy jedzenie z powrotem na Twój stolik. I tu właśnie wkracza kelner, czyli API. Kelner jest posłańcem – czyli API – który przyjmuje Twoje żądanie lub zamówienie i przekazuje kuchni – czyli systemowi – co ma zrobić. Następnie kelner dostarcza Ci odpowiedź; w tym przypadku jest to jedzenie.

Podsumowując, gdy firma udostępnia swoim klientom API, oznacza to po prostu, że stworzyła zestaw dedykowanych adresów URL, które zwracają czyste odpowiedzi w postaci danych — co oznacza, że odpowiedzi te nie będą zawierały elementów prezentacyjnych, których można by się spodziewać 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:

Dane to informacje wysyłane do punktu końcowego, czyli dane niezbędne do dodania uczestnika.

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

Webhooki można wykorzystywać w połączeniu z wywołaniami API w celu zainicjowania różnych działań. Gdy zostanie wysłany webhook zawierający ładunek niezbędny do wykonania określonego wywołania API, wywołanie API zostanie zrealizowane i uczestnik zostanie dodany. Webhooki muszą być wysyłane z Państwa systemu do naszego punktu końcowego i należy je samodzielnie skonfigurować w Państwa systemie.

Poniższe akapity stanowią część fikcyjnego przypadku użycia, mającego na celu wyjaśnienie, w jaki sposób webhooki i interfejsy API mogą ze sobą współpracować.

Kierownik działu kadr utworzył kurs dla początkujących oraz egzamin dla nowo zatrudnionych pracowników. Kierownik działu kadr chce, aby pracownicy odbyli kurs, ale dostęp do egzaminu mają uzyskać dopiero po jego ukończeniu. Dopiero po zdaniu egzaminu pracownicy mają uzyskać dostęp do akademii, w której znajdują się 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 ramach systemu Easy LMS. Proces wygląda następująco.

Kierownik działu kadr musi utworzyć webhook, który po ukończeniu kursu przez pracownika wyśle dane do API egzaminu. Ten webhook musi zawierać jedynie dane niezbędne do wywołania API egzaminu. W tym przypadku korzystamy z wywołania API „Dodaj uczestnika do egzaminu (zaproszenie) ”. Po wysłaniu tego webhooka wywołanie API zostanie uruchomione, jeśli otrzymamy pozytywną odpowiedź. Wywołanie API dodaje uczestnika i automatycznie wysyła zaproszenie na egzamin.

Drugi webhook, który kierownik działu kadr musi utworzyć, służy do sytuacji, gdy pracownik pomyślnie zda egzamin, aby uzyskać dostęp do akademii. Również w tym przypadku ładunek tego webhooka powinien zawierać wyłącznie informacje potrzebne wywołaniu API akademii do dodania uczestnika i wysłania zaproszenia. Po wysłaniu tego webhooka zostanie wywołane API akademii, które następnie doda uczestnika do akademii i wyśle zaproszenie.

Podsumowując:

Klient chce wykorzystać nasze narzędzie do szkolenia swoich (nowych) pracowników. Obecnie korzysta z ustawienia „Wstępnie zdefiniowana grupa 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 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 interfejsu API Egzaminu – „Dodaj uczestnika bez powiadamiania”. Gdy do systemu zostanie dodany nowy pracownik, webhook wysyła dane do interfejsu API egzaminu, który dodaje tego pracownika. Wywołanie API nie powoduje wysłania zaproszenia do tego pracownika. Jeśli wywołanie API zakończy się powodzeniem, odpowiedź zawiera dane logowania. Dane te muszą następnie zostać przesłane pracownikowi z własnego systemu i aplikacji pocztowej.

Działa to również w przypadku obecnych pracowników – wystarczy utworzyć webhook, który wysyła dane do interfejsu API egzaminu, co uruchamia akcję dodania uczestników do egzaminu bez powiadamiania. 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 za pośrednictwem własnej witryny e-commerce. Chce zautomatyzować ten proces po dokonaniu przez klientów płatności za egzamin.

Aby zautomatyzować proces sprzedaży, klient musi skorzystać z webhooka. Gdy klienci klienta dokonują zakupu lub płacą za egzamin na jego stronie e-commerce, są dodawani do jego systemu. Utworzony przez niego webhook musi zostać uruchomiony po dokonaniu płatności. Webhook ten wyśle następnie odpowiedni ładunek do wywołania API egzaminu i musi zwrócić odpowiedź potwierdzającą powodzenie lub błąd. Jeśli odpowiedź jest pozytywna, wywołanie API dodaje klientów i zaprasza ich do egzaminu, za który zapłacili.
​

Nasze API akceptuje formaty application/x-www-form-urlencoded, multipart/form-data oraz JSON.

Więcej informacji znajdziesz w poniższych artykułach: