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 wysłać żądanie lub zadać pytanie, po czym, po przekazaniu odpowiednich informacji, wywołanie API wykonuje przewidzianą czynność.

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

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 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:

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

Punkt docelowy 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 mogą być wykorzystywane w połączeniu z wywołaniami API w celu zainicjowania różnych działań. Gdy zostanie wysłany webhook zawierający dane niezbędne do wykonania określonego wywołania API, wywołanie API wykona swoje zadanie i doda uczestnika. webhooki muszą być wysyłane z Twojego systemu do naszego punktu końcowego i musisz je samodzielnie skonfigurować w swoim systemie.

Poniższe akapity stanowią część fikcyjnego scenariusza użytkowania, 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 przeznaczony 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 wysyła dane do interfejsu API egzaminu. Webhook ten musi zawierać wyłącznie dane niezbędne do wywołania interfejsu 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 otrzymana zostanie pozytywna odpowiedź. Wywołanie API dodaje uczestnika i automatycznie wysyła zaproszenie na egzamin.

Drugi webhook, który musi utworzyć kierownik działu kadr, 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, po czym uczestnik zostanie dodany do akademii i otrzyma zaproszenie.

Podsumowując:

Klient chce wykorzystać nasze narzędzie do szkolenia swoich (nowych) pracowników. Obecnie korzysta z ustawienia Z góry 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 dane do API egzaminów – dodaj uczestnika bez powiadamiania. Gdy nowy pracownik zostanie dodany do systemu klienta, webhook wysyła dane do API egzaminów, które dodaje tego pracownika. Wywołanie API nie wysyła zaproszenia do tego pracownika. Gdy 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 bez powiadamiania o egzaminie. Dane logowania zwrócone w odpowiedzi na wywołanie API można następnie przesł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 będzie musiał skorzystać z webhooka. Gdy klienci klienta kupią lub opłacą egzamin w jego witrynie e-commerce, zostaną dodani do jego systemu. Webhook, który tworzy, musi zostać uruchomiony po dokonaniu płatności. Następnie ten webhook wyśle 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.

Dowiedz się więcej z poniższych artykułów: