Czym jest REST API?

REST API (nazywany również RESTful API) to interfejs sieciowy, który jest zbudowany zgodnie ze specyfikacjami standardu REST. REST API są używane przez usługi sieciowe i inne systemy w celu udostępniania wybranych zasobów (danych) innym systemom. Zasoby te mogą być następnie konkretnie adresowane, pobierane lub zmieniane za pomocą klienta REST.

Ze względu na swoją prostotę i elastyczność, REST API jest jednym z najpopularniejszych interfejsów sieciowych i jest szeroko stosowany w różnych obszarach. Niezależnie od tego, czy chodzi o usługi online, takie jak PayPal i LinkedIn, aplikacje oprogramowania przemysłowego, czy nawet urządzenia
gospodarstwa domowego – REST API jest często pierwszym wyborem, gdy systemy muszą komunikować się ze sobą w nieskomplikowany sposób.

Jak działa REST API?

Interfejs API REST ułatwia wymianę lub modyfikację danych między różnymi systemami, wykorzystując dobrze znany protokół HTTP. Korzystając z metod HTTP GET, POST, PUT i DELETE, dane można nie tylko pobrać za pośrednictwem interfejsu REST API, ale także zmodyfikować lub usunąć (jeśli interfejs REST API na to pozwala).

W tej sekcji wyjaśnimy podstawową funkcjonalność interfejsu REST API, wykorzystując jako przykład usługę pogodową OpenWeatherMap.

Struktura interfejsu REST API

Każdy interfejs REST API ma adres URL (znany również jako nazwa hosta lub adres URL hosta), którego można użyć do jego adresowania.

Przykład: https://api.openweathermap.org/data/2.5/

Sam interfejs API REST składa się z różnych zasobów. Reprezentują one informacje przechowywane na serwerze i mogą być adresowane za pośrednictwem endpoint-u lub odpowiadającego mu identyfikatora URI (Uniform Resource Identifier).

Na przykład, aby odnieść się do punktu końcowego „pogoda” i podstawowego zasobu interfejsu REST API OpenWeatherMap, wymagany jest następujący adres URL:

https://api.openweathermap.org/data/2.5/weather

Ponadto interfejs REST API zwykle zawiera dokumentację, która zawiera informacje o dostępnych endpoint-ach, a także możliwych parametrach i formatach danych (patrz poniżej).

Komunikacja z interfejsem REST API

W praktyce komunikacja z interfejsem REST API odbywa się za pośrednictwem protokołu HTTP.

Można użyć różnych metod HTTP (poleceń). Określają one sposób interakcji z adresowanym zasobem. Żądanie GET żąda informacji z interfejsu REST API, podczas gdy żądania POST i PUT mogą być używane do tworzenia nowych zasobów lub zmiany istniejących. Polecenie DELETE usuwa określony zasób.

Żądania POST, PUT i DELETE mogą być używane na przykład do publikowania, modyfikowania lub usuwania wpisów blogowych w witrynie.

Przykład żądania GET:

W odpowiedzi na prawidłowe żądanie GET, REST API zwraca reprezentację żądanego zasobu (dane). Reprezentacja ta może być przesyłana w różnych formatach danych, przy czym najczęściej używane są HTML, JSON i XML.

Dodatkowe parametry służą do informowania endpoint-u, które komponenty zasobu mają zostać dostarczone. Na przykład endpoint „weather” interfejsu API OpenWeatherMap można adresować za pomocą parametrów „id” i „appid”. Parametr „id” to kod miasta, podczas gdy kod weryfikacyjny (klucz API) musi zostać przesłany za pomocą parametru „appid”.

Takie żądanie GET mogłoby wyglądać następująco:

GET https://api.openweathermap.org/data/2.5/weather?id=  2839763&appid=123456789abcdefghij

Jeśli klucz API jest poprawny, bieżące dane pogodowe są zwracane w formacie JSON.

Zalety interfejsu REST API

Interfejsy REST API są uważane za elastyczne i bezpieczne do komunikacji między różnymi systemami. Ustandaryzowana struktura i wykorzystanie ustalonej technologii internetowej skutkują niskimi barierami wejścia.

Do najważniejszych zalet interfejsu REST API należą:

Prosta integracja: Interfejsy REST API są ustrukturyzowane według tego samego wzorca, używają protokołu HTTP i są stosunkowo łatwe w użyciu. Umożliwia to elastyczną integrację z szeroką gamą platform, usług i systemów, niezależnie od używanych systemów operacyjnych oraz języków
programowania.

Skalowalność: REST charakteryzuje się zasadą bezstanowości, tj. pojedyncze żądanie zawiera wszystkie informacje wymagane do przetworzenia tego żądania. Serwer nie wspiera pośredniego magazynowania, a dane są dostarczane niezależnie od żądających klientów. Oznacza to, że żądania mogą być udostepniane na kilka serwerów (równoważenie obciążenia), a interfejs REST API można łatwo rozszerzyć o nowe serwery w dowolnym momencie.

Bezpieczeństwo: W praktyce REST wykorzystuje mechanizmy bezpieczeństwa komunikacji HTTPS. Oprócz szyfrowania HTTPS można używać metod uwierzytelniania, takich jak OAuth lub OpenID. Możliwe jest również filtrowanie żądań przez zapory sieciowe.

Przykłady REST API

Ze względu na powszechne stosowanie REST istnieje wiele przykładów interfejsów REST API. Poniżej wymieniliśmy kilka z nich:

• • OpenWeatherMap: W tym artykule dla przykładów, odwołaliśmy się do interfejsu REST API usługi pogodowej OpenWeatherMap. Możesz dowiedzieć się, jak działa pobieranie bieżących danych pogodowych w naszym przewodniku krok po kroku: Zapytanie o dane pogodowe z OpenWeather za pomocą REST.
  • Microsoft Teams: Wiadomości i linki można wysyłać w Microsoft Teams za pośrednictwem interfejsu REST API. Szczegółowe instrukcje można znaleźć tutaj: Połącz Microsoft Teams za pomocą wtyczki REST.
  • PayPal: Za pomocą interfejsów REST API PayPal operatorzy sklepów internetowych lub podobnych usług mogą komunikować się z serwerami PayPal i integrować usługę płatności ze swoją witryną.
  • ThingWorx: ThingWorx to platforma IoT, która może być używana do centralnej wizualizacji i zarządzania urządzeniami, czujnikami oraz maszynami z dostępem do Internetu. W naszym przewodniku krok po kroku dotyczącym połączenia REST platformy ThingWorx pokazujemy, jak dane mogą być odczytywane z lub zapisywane do profili urządzeń za pośrednictwem interfejsu REST API.
  • Drukarka etykiet Zebra: Oprócz wielu usług sieciowych, urządzenia przemysłowe i domowe również wykorzystują interfejsy REST API na wiele sposobów. Interfejs REST API drukarki etykiet Zebra może być na przykład używany do przesyłania zadań drukowania do urządzenia. Więcej informacji można znaleźć tutaj.
  • Waga laboratoryjna Cubis® II: Cubis® II firmy Sartorius również implementuje interfejs REST API, umożliwiając nie tylko pobieranie zmierzonych wartości, ale także zewnętrzne sterowanie wagą.

W naszym artykule Przemysłowe wykorzystanie interfejsów REST API – pięć praktycznych przykładów, omawiamy bardziej szczegółowo różne przypadki zastosowania interfejsów REST API w przemyśle.

Więcej informacji

Przeczytaj, w jaki sposób wtyczka REST umożliwia wykonywanie zapytań dotyczących danych z różnych systemów za pośrednictwem interfejsu REST API lub jak można jej użyć do utworzenia interfejsu REST API dla podłączonych systemów.