Połącz się z API bez kodu: 8 kroków

2024 Autor: John Day | [email protected]. Ostatnio zmodyfikowany: 2024-01-30 11:28

Ten przewodnik jest przeznaczony dla osób, które chcą zrobić coś, co wymaga użycia interfejsu API, ale nie są do końca pewni, jak zacząć. Wiesz już, dlaczego możliwość pracy z interfejsem API jest przydatna, a ten przewodnik pokaże Ci, jak to zrobić.

Jeśli to brzmi jak ty, masz szczęście! Jesteśmy tutaj, aby wyjaśnić, jak pracować z interfejsami API, jak czytać dokumentację interfejsu API i jak faktycznie korzystać z danych wracających z interfejsu API.

Zabraliśmy ze sobą przyjaciela, aby podróż była znacznie łatwiejsza.

Poznaj Slash

Slash to uroczy, sympatyczny pies Michelle (na zdjęciu powyżej). Michelle jest inżynierem oprogramowania, który tworzy interfejsy API. Michelle naprawdę lubi swoją pracę i czerpała inspirację ze swojej pracy nad tworzeniem interfejsów API w szkoleniu Slasha.

Jak być może wiesz, API to zbiór poleceń, które użytkownik może przekazać usłudze sieciowej wraz z zestawem odpowiedzi pasujących do żądania. Michelle wyszkoliła Slasha, by robił to samo. Slash jest grzecznym chłopcem, zna różne komendy i zawsze odpowiada poprawnie, o ile prosisz go, by go nauczono. Kiedy jest bardzo podekscytowany, jego ogon wariuje - nie jest to coś, czego nauczyła go Michelle w związku z API, tylko dlatego, że jest uroczym szczeniakiem i naprawdę lubi jego trening!

Krok 1: Zdecyduj, jakiego interfejsu API potrzebujesz

Jakich informacji szukasz lub chcesz zmienić?

Czy próbujesz złapać wszystkie posty na Instagramie @doughthepug? Może chcesz automatycznie tweetować do każdego, kto śledzi twitter twojego psa (ponieważ psy nie mogą mówić, mają wiele do powiedzenia, wiemy, że Slash z pewnością tak).

Jeśli znasz już witrynę lub interfejs API, z którym próbujesz się połączyć, przejdź bezpośrednio do kroku 2. Jeśli próbujesz znaleźć dane, ale nie wiesz, od czego zacząć, Google jest Twoim przyjacielem. Wyszukaj „[rzeczy, które Cię interesują] API” i zobacz, co się pojawi. Możesz być zaskoczony, ile informacji jest tam dostępnych.

Jeśli chcesz prosty przykładowy interfejs API, możesz użyć tego, które stworzyła Michelle podczas trenowania Slasha. Zawiera niektóre z jego ulubionych poleceń, takie jak aportowanie piłek i kopanie dziur. Będziemy go używać w pozostałych przykładach.

Krok 2: Znajdź dokumenty API

Interfejsy API dostarczane przez znane firmy powinny mieć dokładną dokumentację, jak z nich korzystać.

Aby je znaleźć, wyszukaj w wyszukiwarce „[Insert Company] API dokumentację” lub „[Insert Company] Developer”.

Wyniki powinny przenieść Cię do portalu dla programistów. Poszukaj linku „Dokumenty”, „Dokumentacja”, „Odniesienia” lub „Informacje techniczne”.

W dokumentach może być konieczne wyszukanie konkretnego interfejsu API, który chcesz, ponieważ czasami może być wiele opcji. Na przykład Facebook ma oddzielne interfejsy API do marketingu, reklam, stron i nie tylko.

Jeśli interfejs API, z którym chcesz się połączyć, nie jest dobrze znany (np. Slash), możesz poprosić programistę o dokumentację. Mogą mieć plik PDF zawierający potrzebne informacje lub dokumentację online, która nie jest wymieniona na ich stronie internetowej.

Jeśli przegapiłeś link w poprzednim kroku, dokumentację API Slasha znajdziesz tutaj.

Krok 3: Znajdź punkt końcowy

Dokumentacja API może wydawać się zniechęcająca, ale gdy już wiesz, czego szukać, jest zwykle dobrze ustrukturyzowana i dość ustandaryzowana.

Pierwszą rzeczą, której należy szukać, jest odpowiedni punkt końcowy. Powinien istnieć jeden punkt końcowy odpowiadający każdemu typowi danych, które chcesz. Punkt końcowy może wyglądać tak:

slashtheapidog.com/api/bones/{id}

Lub tylko

/kości

Dokumentacja powinna zawierać listę punktów końcowych. Mogą znajdować się na najwyższym poziomie w dokumentach lub w sekcji o nazwie „informacje”, „punkty końcowe” lub „metody”. Aby znaleźć właściwy punkt końcowy, poszukaj nazwy odpowiadającej danym, których szukasz. Na przykład, jeśli chcesz otrzymać listę wszystkich dziur wykopanych przez Slasha, prawdopodobnie właściwym jest /holes. W każdym razie każdy punkt końcowy powinien mieć opis, który pomoże wyjaśnić, co robi.

Z jego dokumentów są to punkty końcowe w API Slasha związane z dziurami:

POBIERZ

POBIERZ

POST

PUT

POST

Krok 4: Określ typ żądania

Teraz, gdy znalazłeś właściwy punkt końcowy, musisz określić typ żądania, aby go wysłać.

Istnieją 4 różne rodzaje wniosków:

DOSTWAĆ

Żądanie GET to sposób, w jaki prosisz API o odpowiedź z czymś, co ma, najczęściej danymi. Możesz poprosić o szczegółowe informacje o jednym elemencie lub grupie elementów na podstawie punktu końcowego i parametrów. Jest to odpowiednik poproszenia Slasha o przyniesienie jednej z jego kości lub wszystkich jego kości.

POCZTA

Żądanie POST to sposób, w jaki mówisz interfejsowi API, aby utworzył coś nowego. Jest to podobne do proszenia Slasha o wykopanie (stworzenie) dla ciebie nowej dziury.

POŁOŻYĆ

Żądanie PUT to sposób, w jaki informujesz interfejs API, aby zaktualizował coś, co zostało wcześniej utworzone. Jest to podobne do proszenia Slasha, aby kopał głębiej (aktualizacja) w wykopanej przez siebie dziurze.

KASOWAĆ

Żądanie DELETE to sposób, w jaki każesz interfejsowi API usunąć coś, co zostało wcześniej utworzone. Jest to podobne do proszenia Slasha o zakrycie (usunięcie) dziury, którą wcześniej wykopał.

Pomyśl o tych czterech typach. Czy otrzymujesz informacje, tworzysz nowy wpis, zmieniasz istniejący lub usuwasz? Ta odpowiedź mówi dokładnie, jakiego typu żądania potrzebujesz.

Krok 5: Zrozum parametry

Wiele żądań wymaga dodatkowych parametrów. Parametry to szczegóły Twojego żądania. Na przykład, jeśli chcesz, aby Slash przyniósł ci wszystkie kule, które są czerwone, musisz określić kolor. Jeśli chcesz, aby stworzył nową dziurę, musisz powiedzieć mu, gdzie ją umieścić i jak głęboko kopać.

Dokumentacja interfejsu API, do której się odwołujesz, powinna zawierać sekcję o nazwie „Parametry” lub „Opcje” dla każdego punktu końcowego i typu żądania. Zwróć uwagę, które parametry są wymagane, ponieważ niektóre są opcjonalne. Jeśli parametr jest oznaczony jako opcjonalny, dokumentacja może zawierać przykład, który jest również domyślny.

Parametry API Slasha mogą wyglądać mniej więcej tak w przypadku pobierania piłek:

POBIERZ

Krok 6: Sformatuj swoje żądanie

Mamy wszystkie potrzebne informacje, teraz wystarczy złożyć wniosek!

Oto dwa różne sposoby łączenia się z interfejsem API, które nie wymagają kodu. Połączmy się z API Slasha, aby uzyskać jego listę piłek, wysyłając żądanie GET na

Parabola - jeśli chcesz łączyć się i pracować z danymi bez kodu

Parabola to aplikacja internetowa, która umożliwia łatwe łączenie się z interfejsami API, a następnie pracę z danymi za pomocą wizualnego narzędzia przeciągania i upuszczania.