Co oznacza API? Przykłady korzystania z interfejsów API

API oznacza „interfejs programowania aplikacji”. I chociaż może to zabrzmieć dziwnie, jeśli jesteś nowy w programowaniu, łatwo je zrozumieć, gdy już je podzielisz. Używasz ich nawet codziennie podczas obsługi telefonu komórkowego, komputera lub przeglądania Internetu.

Oprogramowanie, w tym aplikacje internetowe, aplikacje mobilne i wiele innych programów, łączy świat za pośrednictwem Internetu. Ale aby uczynić to bardziej wydajnym, musi istnieć kanał komunikacyjny między tym oprogramowaniem — tam właśnie pojawia się interfejs API.

Tutaj wyjaśnimy znaczenie interfejsów API i sposób ich użycia.

Co to jest interfejs API?

Czy wiesz, jak możesz oglądać filmy na platformach strumieniowych, takich jak Netflix i YouTube, między innymi? Jest to możliwe, ponieważ wysyłasz żądanie przez interfejs API.

A może wyobrażałeś sobie, jak możesz zapłacić za towary kupowane w sklepach internetowych, takich jak Amazon i eBay? Dzieje się tak również dlatego, że istnieje kanał komunikacji znany jako interfejs API między Twoim bankiem a aplikacjami zakupowymi.

To powiedziawszy, interfejs API to interfejs z zestawem reguł, które umożliwiają serwerowi aplikacji interakcję z serwerem dostawcy rozwiązania, dzięki czemu można korzystać z jego zasobów. Zasadniczo definiuje sposób, w jaki aplikacje lub oprogramowanie komunikują się ze sobą.

Jednak w niektórych przypadkach interfejs API umożliwia wzajemną wymianę danych. Przykładem jest połączenie, które istnieje między aplikacjami bankowymi a aplikacjami sklepu internetowego.

API jest jak komunikator. Łączy się z serwerem dostawcy na jednym końcu, a także zakotwicza serwer klienta na drugim końcu. Następnie przekazuje żądanie klienta do źródła danych (serwera dostawcy) i zwraca odpowiedź do klienta. Klientem jest tutaj przeglądarka lub Twoja aplikacja.

Jednak hak dołącza Twoją aplikację do interfejsu API. To jest punkt końcowy API. Jednak wiele rzeczy dzieje się za kulisami. Wyjaśnimy to dalej.

Jak interfejsy API pomagają szybciej tworzyć aplikacje

Interfejsy API to inteligentniejsze narzędzie do tworzenia bezproblemowych i niezawodnych aplikacji. Bez nich tworzenie wyrafinowanych aplikacji zajęłoby wieki.

Wyobraź sobie, że potrzebujesz swojej aplikacji do wykonywania złożonych operacji, których zbudowanie zajmuje mnóstwo czasu i wysiłku. A potem pojawia się ktoś z gotowym programem, który robi dokładnie to, czego chcesz, a może nawet lepiej.

Ale jak możesz to połączyć ze swoją aplikacją? Dostawca, zdając sobie z tego sprawę, może sprawić ci trochę trudności, a następnie powiedział ci, że stworzył interfejs połączenia (API), który sprawia, że ​​ich kod i twój integrują się bezproblemowo.

Ten interfejs (API) łączy się z serwerem zawierającym ich kod. Następnie przesyła odpowiednie dane z działania ich skryptu.

Oczywiście nie chcesz się nudzić całym ich skryptem źródłowym. Poza tym większość nowoczesnych interfejsów API opiera się teraz na standardowej technologii REST (Representational State Transfer). Dzięki temu są wysoce skalowalne i łatwe do zintegrowania, bez konieczności martwienia się o to, co dzieje się w środku, ani o stan odpowiedzi lub żądania podczas ich wstępnego formatowania.

Ten artykuł nie będzie dalej wyjaśniał REST API. Na razie skup się na podstawach.

Podłączenie kodu do ich kodu jest lepszym pomysłem niż pisanie go od zera. Aby to zrobić, musisz jednak połączyć swój kod z udostępnionym przez nich interfejsem API. Jak Ty to robisz? W tym miejscu pojawia się punkt końcowy API.

Co to jest punkt końcowy interfejsu API?

Aby uprościć sprawę, dostawcy następnie umieszczają adres URL, aby połączenie z ich interfejsem API było bezproblemowe. Taki adres URL to Punkt końcowy API API. Dzięki niemu Twoja aplikacja może uzyskać dostęp do swojego serwera za pośrednictwem interfejsu API i bezpośrednio komunikować się ze swoim skryptem.

Więc wszystko, co musisz zrobić, to pobrać punkt końcowy, wkleić go do swojego kodu, wysyłać za jego pomocą żądania, dostosowywać odpowiedzi, a następnie działa i jest Twój! W związku z tym punkt końcowy interfejsu API wiąże aplikację za pośrednictwem interfejsu API z rozwiązaniem lub źródłem danych.

Ostatecznie wiele programów oferujących interfejsy API jest dostępnych w różnych językach programowania, dzięki czemu nikt nie zostanie wykluczony z korzystania z nich.

W ten sposób możesz szybciej i wydajniej kodować, wiedząc, że ciężar utrzymania interfejsu API nie spoczywa na Tobie, ale na dostawcach danych lub rozwiązań.

Dlatego punkt końcowy API jest zaczepem komunikacyjnym, który wiąże API z serwerem zasobów na jednej krawędzi i łączy go z serwerem odbiorcy na drugim końcu.

Oznacza to, że nie potrzebujesz całego skryptu rozwiązania, którego chcesz użyć. Ale Twój kod nie może nawiązać z nim komunikacji, jeśli nie łączy się z punktem końcowym interfejsu API.

Zasady integracji API

Nie ma sztywnych zasad dotyczących integracji API. Jest ich mnóstwo, a każdy z nich ma swoje zasady integracji. Pamiętaj jednak, że spodziewasz się odpowiedź za każdym razem, gdy nawiązujesz połączenie z API.

Sposób wysyłania żądań za pośrednictwem punktu końcowego interfejsu API jest zwykle oparty na regułach zdefiniowanych przez dostawcę, ale to, co robisz z otrzymaną odpowiedzią, zależy od Twoich preferencji. Zasadniczo możesz ją dowolnie zmieniać, aby dostosować ją do środowiska i interfejsu użytkowników aplikacji.

Czasami potrzebujesz również tokena uwierzytelniającego, zanim uzyskasz dostęp do interfejsu API. Takie uwierzytelniacze zwykle występują jako tokeny dostępu lub klucze API. Gdy ten token przejdzie test uwierzytelniania, interfejs API sygnalizuje swojemu punktowi końcowemu połączenie między aplikacją a serwerem dostawcy.

Jako konsument interfejsu API nie musisz się martwić o te parametry, ponieważ dostawca interfejsu API udostępnia je. Świetny interfejs API powinien również określać, w jaki sposób można uzyskać dostęp i korzystać z jego zasobów w swojej dokumentacji. Dlatego zawsze zwracaj uwagę na to, gdy próbujesz zintegrować jeden.

Podsumowując, w wywołaniu API chodzi o nagłówki, i punkt końcowy, żądanie, a odpowiedź albo ciało.

Chociaż wyjaśniliśmy, czym jest punkt końcowy, przyjrzyjmy się dalej innym terminom:

Nagłówki

Zwykle podczas łączenia się z API musisz opisać dwie formy nagłówków: żądanie i odpowiedź nagłówki.

nagłówek żądania jest bramą wywołania API. Opisuje podejście klienta do dostępu do zasobu. Może zawierać szczegóły, takie jak akceptowalny typ połączenia, informacje o serwerze proxy i typ danych (JSON, XML lub HTML), które chcesz uzyskać z interfejsu API.

Jak opisaliśmy wcześniej, w zależności od typu interfejsu API, z którym się łączysz, może być konieczne podanie unikalnego tokenu uwierzytelniania również w nagłówku żądania. Dostawca zwykle to daje.

nagłówek odpowiedziz drugiej strony jest potwierdzeniem danych pochodzących z serwera dostawcy. Daje aplikacji informacje o cechach dostawcy. Zasadniczo zapewnia, że ​​Twoja aplikacja udziela dostępu do odpowiedzi pochodzącej z interfejsu API.

Żądanie API

Żądanie API zwykle zawiera punkt końcowy w adresie URL (Unique Resource Locator). Wykorzystuje protokół Hypertext Transfer Protocol (HTTP) do zlokalizowania adresu zasobu, do którego próbujesz uzyskać dostęp za pomocą interfejsu API. Ostatecznie żądanie interfejsu API nie jest kompletne, jeśli nie uwzględnisz punktu końcowego w adresie URL.

Odpowiedź API

Odpowiedź to odpowiedź, którą interfejs API wysyła z powrotem za każdym razem, gdy otrzymuje żądanie z Twojej aplikacji. Może to być JSON, XML lub HTML, w zależności od danych lub typu zawartości, które otrzymuje z nagłówka żądania.

Gdy otrzymasz odpowiedź z interfejsu API, możesz uznać, że wywołanie interfejsu API zakończyło się sukcesem.

Jak korzystać z API: praktyczne przykłady

Teraz, gdy znasz podstawy interfejsów API i wiesz, czego potrzebujesz, aby je zintegrować. Zobacz, jak podłączyć i zintegrować API prognoz piłkarskich z RapidAPI za pomocą Pythona poniżej.

Jest to proste wywołanie API, które zwraca odpowiedź JSON. Możesz również napisać swój kod w dowolny edytor tekstui uruchom go za pomocą wiersza poleceń.

Związane z: Jak uruchomić skrypt Pythona

Zwróć jednak szczególną uwagę na punkt końcowy, zawartość nagłówków żądań i nagłówków odpowiedzi:

żądania importu
punkt końcowy = " https://football-prediction-api.p.rapidapi.com/api/v2/predictions"
queryparams = {"market":"klasyczny","iso_date":"2021-01-01","federation":"UEFA"}
#Zdefiniuj nagłówek żądania:
nagłówki = {
'x-rapidapi-key': "Wklej tutaj swój klucz dostępu",
'x-rapidapi-host': "piłka-przewidywanie-api.p.rapidapi.com"
}
#Zdefiniuj nagłówek odpowiedzi:
response = requests.request("GET", endpoint, headers=headers, params=queryparams)
#Uzyskaj odpowiedź:
drukuj (odpowiedź.tekst)

Ucz się: Jak korzystać z IPStack API do wyszukiwania geolokalizacji IP

Co powiesz na uzyskanie aktualnej temperatury i wilgotności miejsca za pomocą? API Weatherstack z Pythonem? Oto przykład poniżej:

żądania importu
punkt końcowy = ' http://api.weatherstack.com/current'
nagłówki = {
"access_key": "Wklej tutaj swój klucz dostępu",
"zapytanie": "Kalifornia"
}
zad = request.get (punkt końcowy, nagłówki)
res = zad.json()
print (u"Aktualna temperatura w %s wynosi %d℃" % 
(res["lokalizacja"]["nazwa"], res["bieżąca"]["temperatura"]))
print (u"Aktualna wilgotność w %s wynosi %d℃" % 
(res["lokalizacja"]["nazwa"], res["bieżąca"]["wilgotność"]))

Rodzaje interfejsów API, które można zintegrować

Interfejsy API typu open source są bezpłatne i każdy może z nich korzystać. Wewnętrzne interfejsy API znajdują się w organizacji i tylko aplikacje należące do tej organizacji mogą korzystać z jej zasobów.

Możesz jednak również zdecydować się na dedykowane API, zawierając umowę partnerską z dostawcą. Możesz też połączyć kilka interfejsów API, aby rozwiązać różne problemy.

Ponadto te interfejsy API, z wyjątkiem interfejsów API typu open source i wewnętrznych, mogą mieć cenę, czasami sięgającą od setek do tysięcy dolarów.

Uprość tworzenie aplikacji dzięki interfejsom API

Jak widzisz, nie musisz już pisać czasochłonnego kodu. Jeśli potrzebujesz aplikacji do wykonywania złożonych operacji, zawsze możesz ją wyszukać i pobrać odpowiedni interfejs API. Na szczęście są teraz nawet łatwe do zintegrowania niż stare konwencjonalne. A jeśli jesteś ciekawy i chcesz dowiedzieć się więcej, istnieje wiele darmowych interfejsów API, które pomogą Ci ubrudzić sobie ręce.

Jak działają interfejsy API i jak je zintegrować z aplikacją

Korzystanie z interfejsów programowania aplikacji (API) jest podstawową umiejętnością do opanowania przez wszystkich programistów.

Czytaj dalej

O autorze