Podstawy API WordPress: co to znaczy i jak z niego korzystać

Opublikowany: 2016-03-03

Być może słyszeliście szum o WordPress JSON REST API. To wielka wiadomość dla użytkowników WordPressa i powód do świętowania!

JSON, REST, API – to jednak dużo żargonu na jedną nazwę, więc zróbmy to wszystko.

Co to jest API?

API oznacza „interfejs programowania aplikacji”, który jest zestawem instrukcji programowania i standardów dostępu do aplikacji internetowej lub narzędzia internetowego. Wyobraź sobie „oprogramowanie jeden”, które podaje instrukcje „oprogramowanie dwa”. API to umowa między nimi, a linie komunikacji są otwarte. Zasadniczo to, co sobie mówią, jest czymś w rodzaju „kiedy dasz mi instrukcję, wykonam działanie lub zwrócę prawidłowe informacje”.

Gdy przeszukujemy sieć i korzystamy z różnych rozwiązań programowych, jesteśmy przyzwyczajeni do interfejsów użytkownika z określonymi układami, przyciskami i grafiką, z którymi wchodzimy w interakcję, aby wykonać pożądane zadania. Wszystko to jest bezużyteczne dla maszyny, ponieważ wszystko, na czym im zależy, to dane i to, co muszą zrobić i jak z nimi współdziałają. Interfejs API jest alternatywą oprogramowania dla „interfejsu użytkownika”, dając instrukcje drugiemu oprogramowaniu, jak uzyskać dane i inne określone zadania. Są całkowicie niewidoczne dla użytkowników korzystających z aplikacji internetowej i są po prostu interfejsem między oprogramowaniem.

wordpress-api-oprogramowanie-do-oprogramowania

Przykłady API

Posiadanie dostępu do interfejsu API jest niesamowite, gdy tworzysz aplikacje internetowe. Kiedy API jest udostępniane publicznie, oznacza to, że programiści stworzyli rozwiązania, które są obsługiwane przez usługę oprogramowania. Często usuwają potrzebę ponownego wymyślania koła dla wielu zadań, ponieważ zostały już stworzone.

Świetnym przykładem API jest Amazon. Amazon udostępnił swoje API, aby programiści mieli łatwy dostęp do produktów i ich informacji. Dostęp do tego ułatwia publikowanie linków do produktów na amazon, ze zaktualizowanymi cenami i opcją zakupu.

Innym przykładem interakcji interfejsów API może być zakup biletów na koncerty. Aby oficjalnie kupić bilety, musisz podać dane swojej karty kredytowej. Interfejs API służy do wysyłania informacji o karcie kredytowej do zdalnej aplikacji, która następnie weryfikuje, czy informacje o karcie kredytowej są prawidłowe. Gdy wszystko się sprawdzi, zdalna aplikacja wysyła odpowiedź z powrotem do witryny z biletami, mówiąc, że można kontynuować, w którym to momencie pomyślnie kupiłeś bilety. Kiedy to wszystko się dzieje, widzisz tylko jeden interfejs, którym jest strona z biletami. To płynny proces; za kulisami wiele aplikacji współpracuje ze sobą przy użyciu interfejsów API, ale Ty jako użytkownik nie zauważasz, kiedy zadania są przekazywane z jednej aplikacji do drugiej.

API i WordPress

Zakupy Amazon i bilety to świetne przykłady tego, jak współpracują ze sobą interfejsy API, ale jak to się ma do WordPressa?
Cóż, obowiązują te same pomysły. Dzięki API WordPress możesz wypychać i wyciągać dane z WordPressa.

Interfejs API jest kluczowym narzędziem, którego programiści mogą używać do łatwego udostępniania danych ze swojej witryny WordPress innym witrynom lub aplikacjom. W szczególności ten interfejs API umożliwia wykonywanie operacji create , read , update i delete (CRUD) w treści WordPress. Oto kilka przykładów typów treści:

  • Posty
  • Niestandardowe typy postów
  • Strony
  • Taksonomie
  • Użytkownicy
  • Głoska bezdźwięczna

Co oznacza ODPOCZYNEK?

Nie ma tu drzemki ani chrapania, ale REST odnosi się do stylu architektonicznego API. REST oznacza Reprezentacyjny Transfer Stanu. Pamiętasz, jak wspomnieliśmy, że API podaje specyfikę komunikacji, aby programy mogły się ze sobą komunikować? Interfejsy API REST są zaprojektowane w taki sposób, aby zapewniały lekką metodę komunikacji, która oszczędza przepustowość. API WordPress JSON REST właśnie to robi, co czyni go świetną opcją, gdy istnieje duża ilość danych.

Właśnie zarysowaliśmy powierzchnię REST; jeśli chcesz dowiedzieć się więcej, zapoznaj się z tym pomocnym samouczkiem REST.

Format JSON

Aby uzyskać dostęp do danych, potrzebujemy źródła, z którego możemy czerpać. Tutaj wkracza JSON. JSON oznacza JavaScript Object Notation. JSON jest łatwy do odczytania i zrozumienia zarówno dla ludzi, jak i maszyn. To doskonały sposób na przechowywanie informacji w zorganizowany, łatwo dostępny sposób. Ponieważ dostęp do JSON jest tak prosty, doskonale nadaje się do tworzenia interfejsów API REST i jest idealnym rozwiązaniem dla interfejsu API WordPress JSON REST.

Oto podstawowe pojęcie o tym, jak wygląda format JSON:

{"employees":[
	{"firstName":"Jane", "lastName":"Smith"},
	{"firstName":"Anna", "lastName":"Olsen"},
	{"firstName":"Josh", "lastName":"Jones"}
]}

Format JSON w WordPress

JSON nie tylko sam się zapisuje, ale nie martw się, nie musisz ręcznie tworzyć pliku JSON. Jest świetna wtyczka, która tworzy ją za Ciebie. Dzięki temu narzędziu dane witryny będą w odpowiednim formacie, w tym użytkownicy, posty, strony, taksonomie i nie tylko. Wtyczkę można znaleźć tutaj. Istnieje również pomocna dokumentacja, która będzie cenna na początku.

wordpress-api

Korzystanie z interfejsu API JSON REST

Korzystanie z API jest dość oczywiste; będziesz pobierać dane swojej witryny w prostym formacie JSON. A jeśli masz zainstalowaną wtyczkę, możesz bawić się przeglądaniem postów swojej witryny w formie danych.

Pobieranie lub aktualizowanie danych jest tak proste, jak wysłanie żądania HTTP. HTTP to protokół żądania/odpowiedzi. Najpierw wysyłasz prośbę o dane, a następnie dane są odsyłane w odpowiedzi.

Metoda GET

Metoda GET służy do pobierania informacji i nie ma wpływu na dane. Po prostu wyślij żądanie GET do /wp-json/wp/v2/posts . Chcesz czegoś poszukać? Na przykład, jeśli wyszukujesz „development”, otrzymasz wyniki za pomocą żądania GET /wp-json/wp/v2/posts?search=development .

Żądanie POST

Żądanie POST służy do wysyłania danych. Dzięki możliwościom nowego interfejsu API możesz na przykład zaktualizować użytkownika. Załóżmy, że chcesz zaktualizować użytkownika o identyfikatorze 10. Wszystko, co musisz zrobić, to wysłać żądanie POST do /wp-json/wp/v2/users/10 .

Aby to wypróbować, polecam użycie Postman, rozszerzenia Google Chrome.

Więcej Javascript w zestawie

Backbone.js i API

Backbone.js to świetny sposób na pracę z API, ponieważ jest to framework zaprojektowany do pracy z API REST. WordPress API zawiera łatwy w użyciu Javascript API oparty na modelach Backbone. Pozwala to twórcom wtyczek i motywów na rozpoczęcie pracy bez bardzo dogłębnego wysiłku i wiedzy o szczegółach nawiązywania połączenia. Jest o wiele więcej, ale Backbone nadaje strukturę aplikacjom internetowym, dostarczając modele, kolekcje i widoki, a także łączy to wszystko z API WordPress przez interfejs REST JSON.

wordpress-api-backbone

Co to wszystko oznacza dla programistów WordPressa?

Wraz z dostępnością API WordPressa pojawiły się nowe sposoby jego wykorzystania, które będą się rozwijać wraz ze wzrostem popularności. API WordPressa może ulepszyć niemal każdą istniejącą funkcjonalność WordPressa, która opiera się na Javascript. Oto kilka przykładów:

  • walidacja/złożenie formularza
  • Motywy lub wtyczki Backbone.js
  • nieskończone przewijanie

To także świetny sposób na pokazanie treści z innych źródeł. Teraz łatwo jest wyświetlać zawartość z pojedynczej witryny w konfiguracji wielostanowiskowej. Możliwe jest również wyświetlanie treści z całkowicie oddzielnej witryny WordPress. Oprócz wyświetlania treści zawartość można również aktualizować.

Teraz, gdy omówiliśmy podstawową terminologię, wiemy, że JSON to notacja, REST to styl architektoniczny, a API to interfejs, który tworzą. Znajomość podstaw interfejsu API i jego możliwości zapewni dobry start podczas odkrywania nowych możliwości interfejsu API WordPress.