Co oznacza API?

API, skrót od Application Programming Interface, oznacza zestaw kodów funkcji umożliwiających aplikacjom dostęp do określonych danych i interakcję z zewnętrznymi komponentami aplikacji, systemami operacyjnymi lub mikrousługami.

Aby uprościć, interfejs API dostarcza odpowiedź użytkownika do systemu i wysyła odpowiedź systemu z powrotem do użytkownika. Klikasz „dodaj do koszyka”; API informuje witrynę, że dodałeś produkt do koszyka; strona internetowa umieści produkt w Twoim koszyku, a Twój koszyk zostanie zaktualizowany.

Możesz usłyszeć termin „mikrousługi” w odniesieniu do API. To jednak nie to samo. Mikrousługi to styl lub architektura dzieląca funkcjonalność aplikacji internetowej. Podczas gdy API to platforma, w której programiści wchodzą w interakcję z aplikacją internetową. Mikrousługi rzeczywiście mogą użyj API do komunikacji między sobą.

API umożliwia programiście wykonanie określonego „zadzwonienia” lub „żądania” w celu wysłania lub odebrania informacji. Ta komunikacja odbywa się za pomocą języka programowania zwanego „JSON”. Można go również wykorzystać do wykonania określonej akcji, takiej jak aktualizacja lub usunięcie danych. Istnieją cztery podstawowe metody żądania, które można wykonać za pomocą interfejsu API:

GET – zbiera informacje (wyciąganie wszystkich kodów kuponów)

PUT – aktualizuje fragmenty danych (aktualizacja cen produktów)

POST – Tworzy (Tworzenie nowej kategorii produktów)

USUŃ – (Usuwanie wpisu na blogu)

Co to jest JSON i dlaczego jest używany?

JSON (JavaScript Object Notation) służy do reprezentowania danych na serwerze. Jest dość łatwy do odczytania przez ludzi i łatwy do zrozumienia dla maszyn/aplikacji. Spójrzmy na przykład JSON z produktu na BigCommerce:

Łatwo to zrozumieć, ponieważ jest ono podawane w parach klucz/wartość, z kluczem po lewej stronie i wartością po prawej stronie. Klucze są stałym obiektem zdefiniowanym przez aplikację i pozostają takie same jak w przypadku „kategorii”. Natomiast wartości będą unikalne, np. „Koszule”.

Co to jest żądanie API?

Aby żądanie API mogło działać, składa się z kilku elementów. Omówmy je indywidualnie i zobaczmy, jak można je wykorzystać do zbudowania żądania.

Co to jest punkt końcowy?

Istnieją dwie kluczowe części punktu końcowego, które są używane podczas tworzenia żądania API. Jednym z nich jest adres URL. BigCommerce używa https://api.bigcommerce.com/stores/ jako adresu URL dla wszystkich żądań API. Może to wyglądać jak zwykły adres URL, ale jeśli podłączysz go do przeglądarki internetowej, pojawi się komunikat o błędzie 404.

Druga część to ścieżka. Ścieżka będzie się różnić w zależności od tego, co próbujesz osiągnąć. Listę dostępnych ścieżek dla BigCommerce znajdziesz w naszej dokumentacji dla programistów: https://developer.bigcommerce.com/api-reference. W tym przykładzie użyjemy ścieżki produktu, która to /v3/catalog/products.

Kiedy połączymy te dwie części, otrzymamy kompletny punkt końcowy https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Teraz możesz sobie zadać pytanie: „Co to jest {store_hash}?” „Skąd to się wzięło?” Jest to tak zwana zmienna. Zmienne są unikalnymi komponentami punktu końcowego i będą się różnić w zależności od informacji o Twoim sklepie. Zmienną można rozpoznać po nawiasach otwartych i zamkniętych „{ }”.

Co to jest nagłówek?

Nagłówki dostarczają informacji klientowi i serwerowi. Typowymi przykładami nagłówka są dane uwierzytelniające, takie jak „Token uwierzytelniania” lub „ID klienta”. Te dane uwierzytelniające są dostarczane automatycznie podczas tworzenia konta API. Inny popularny nagłówek nazywany jest „typem zawartości” i informuje serwer o tym, jaki typ treści zostanie wysłany. Na przykład powszechnie używanym typem zawartości jest „application/json”, który informuje serwer, że przesyłamy dane JSON.

Co to jest metoda?

Metody to działania podejmowane podczas wysyłania żądania. Wróć myślami do początku, kiedy omawialiśmy GET, PUT, POST i DELETE. Są to wszystkie metody API.

Co to są dane?

Dane żądania, powszechnie nazywane „treścią”, to informacje, które zostaną wysłane do serwera lub zwrócone przez serwer. W poprzednim omówieniu JSON można było zobaczyć przykład danych API. Treść żądania będzie czasami wymagać określonych informacji, zanim będzie mogła zostać dostarczona. Przykładem może być sytuacja, w której edytujesz pojedynczy produkt. Przed wprowadzeniem jakichkolwiek zmian wymagany będzie identyfikator produktu.

Czytaj więcej tutaj.