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 szeroko stosowanym 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 są często pierwszym wyborem, gdy systemy muszą komunikować się ze sobą w nieskomplikowany sposób.

Jak działa API REST?

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 API REST, ale także zmodyfikować lub usunąć (jeśli interfejs API REST na to pozwala).

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

Struktura interfejsu API REST

Każdy interfejs API REST 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 punktu końcowego lub odpowiadającego mu identyfikatora URI (Uniform Resource Identifier).

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

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

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

Komunikacja z interfejsem API REST

W praktyce komunikacja z interfejsem API REST 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 API REST, podczas gdy żądania POST i PUT mogą być używane do tworzenia nowych zasobów lub zmiany istniejących zasobów. 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 punktu końcowego, które komponenty zasobu mają zostać dostarczone. Na przykład punkt końcowy „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.

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 punktu końcowego, które komponenty zasobu mają zostać dostarczone. Na przykład punkt końcowy „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 API REST

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

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

Prosta integracja: interfejsy API REST są strukturyzowane 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 i języków programowania.

Skalowalność: REST charakteryzuje się zasadą bezstanowości, tj. pojedyncze żądanie zawiera wszystkie informacje wymagane do przetworzenia tego żądania. Serwer nie ma pośredniego przechowywania, a dane są dostarczane niezależnie od żądających klientów. Oznacza to, że żądania mogą być dystrybuowane na kilka serwerów (równoważenie obciążenia), a interfejs API REST 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 API REST. Poniżej wymieniliśmy kilka z nich:

• • OpenWeatherMap: W przykładach w tym artykule odwołaliśmy się do interfejsu API REST 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 API REST. Szczegółowe instrukcje można znaleźć tutaj: Połącz Microsoft Teams za pomocą wtyczki REST.
  • PayPal: Za pomocą interfejsów API REST 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 i 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 profili urządzeń lub zapisywane do profili urządzeń za pośrednictwem interfejsu API REST.
  • Drukarka etykiet Zebra: Oprócz wielu usług sieciowych, urządzenia przemysłowe i domowe również wykorzystują interfejsy API REST na wiele sposobów. Interfejs API REST 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 API REST, umożliwiając nie tylko pobieranie zmierzonych wartości, ale także zewnętrzne sterowanie wagą.

W naszym artykule Przemysłowe wykorzystanie interfejsów API REST – pięć praktycznych przykładów, omawiamy bardziej szczegółowo różne przypadki użycia interfejsów API REST 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 API REST lub jak można jej użyć do utworzenia interfejsu API REST dla podłączonych systemów.