Interfejsy API WordPress: czym są i jak z nich korzystać

Opublikowany: 2024-09-13

Interfejs API REST WordPress JSON wywołał spore zamieszanie w społeczności WordPress, oferując nowe możliwości zarówno programistom, jak i twórcom treści.

Choć może to wydawać się skomplikowane, zrozumienie kluczowych terminów, takich jak JSON, REST i API, może uprościć interakcję z szerokimi możliwościami WordPressa.

Co to jest interfejs API?

API oznacza „interfejs programowania aplikacji”, który zasadniczo jest zestawem instrukcji programistycznych i standardów, które umożliwiają komunikację między różnymi aplikacjami.

Wyobraź sobie, że jedna aplikacja przekazuje wskazówki innej — interfejs API to zbiór ustalonych reguł regulujących tę interakcję. Gdy jedno oprogramowanie wysyła instrukcje do drugiego, API ułatwia działanie lub dostarcza niezbędnych informacji.

Można myśleć o interfejsie API jako o „interfejsie użytkownika” pomiędzy dwoma systemami oprogramowania, obsługującym komunikację danych i wykonywanie zadań, ale niewidocznym dla użytkownika końcowego.

laptop na drewnianym biurku

Przykłady API

Dostęp do interfejsu API jest niesamowity, gdy tworzysz aplikacje internetowe. Kiedy interfejs API jest udostępniany publicznie, oznacza to, że programiści stworzyli rozwiązania oparte na usłudze oprogramowania. Często eliminują potrzebę ponownego wynalezienia koła dla wielu zadań, ponieważ zostały już stworzone.

Świetnym przykładem API jest Amazon. Amazon udostępnił swoje API, dzięki któremu programiści mogą łatwo uzyskać dostęp do produktów i informacji o nich. Dostęp do tego ułatwia publikowanie linków do produktów na Amazon, z aktualnymi cenami i możliwością zakupu.

Innym przykładem interakcji interfejsów API mogą być zakupy 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 sprawdza, czy informacje o karcie kredytowej są prawidłowe.

Gdy wszystko się sprawdzi, zdalna aplikacja wysyła odpowiedź do witryny sprzedaży biletów, informując, że można kontynuować, co oznacza, że ​​bilety zostały pomyślnie zakupione. Kiedy to wszystko się dzieje, widzisz tylko jeden interfejs, którym jest strona z biletami. Jest to proces płynny; 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 w Amazonie i biletach to świetne przykłady współpracy interfejsów API, ale jak to się ma do WordPressa?

Cóż, wszystkie te same pomysły mają zastosowanie. Dzięki interfejsowi API WordPress możesz przesyłać i pobierać dane do i z WordPress.

Interfejs API to kluczowe narzędzie, za pomocą którego programiści mogą łatwo udostępniać dane ze swojej witryny WordPress innym witrynom lub aplikacjom. W szczególności ten interfejs API umożliwia wykonywanie akcji create , read , update i delete (CRUD) 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 znaczy ODPOCZYNEK?

Nie ma tu drzemki ani chrapania — REST odnosi się do stylu architektonicznego interfejsu API. REST oznacza reprezentacyjny transfer stanu.

Pamiętasz, jak wspominaliśmy, że interfejs API zapewnia specyfikę komunikacji, dzięki czemu programy mogą się ze sobą komunikować? Interfejsy API REST są zaprojektowane w taki sposób, aby zapewniały lekką metodę komunikacji, która oszczędza przepustowość. Właśnie to robi interfejs API REST WordPress JSON, co czyni go świetną opcją w przypadku dużej ilości danych.

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

formacie JSON

Aby uzyskać dostęp do danych, potrzebujemy źródła, z którego można je wyciągnąć. W tym miejscu wkracza JSON. JSON oznacza notację obiektu JavaScript.

JSON jest łatwy do odczytania i zrozumienia zarówno dla ludzi, jak i maszyn. To doskonały sposób na przechowywanie informacji w zorganizowany i łatwo dostępny sposób. Ponieważ dostęp do JSON jest tak łatwy, doskonale nadaje się do tworzenia interfejsów API REST i jest idealnym rozwiązaniem dla interfejsu API REST WordPress JSON.

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

[javascript]
{"pracownicy":[
{„firstName”: „Jane”, „lastName”: „Smith”},
{“firstName”:”Anna”, “lastName”:”Olsen”},
{“firstName”:”Josh”, “lastName”:”Jones”}
]}

[/javascript]

Format JSON w WordPressie

JSON nie zapisuje się sam, ale nie martw się, nie musisz ręcznie tworzyć pliku JSON. Istnieją wtyczki, które mogą to dla Ciebie utworzyć. Dzięki jednemu z tych narzędzi dane witryny będą miały prawidłowy format, włączając w to użytkowników, posty, strony, taksonomie i nie tylko.

Korzystanie z API REST JSON

Korzystanie z interfejsu API jest dość oczywiste; będziesz pobierać dane swojej witryny w prostym formacie JSON. A jeśli masz zainstalowaną wtyczkę, możesz pobawić 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 żądanie danych, a następnie dane są odsyłane w odpowiedzi.

Metoda POBIERZ

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 szukasz słowa „rozwój”, wyniki otrzymasz za pomocą żądania GET /wp-json/wp/v2/posts?search=development .

Żądanie POST

Do wysyłania danych używane jest żądanie POST. Dzięki możliwościom nowego API możesz na przykład zaktualizować użytkownika. Powiedzmy, ż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ć, zalecamy użycie Postman, rozszerzenia Google Chrome.

Więcej JavaScriptu w miksie

Backbone.js i API

Backbone.js to świetny sposób na pracę z API, ponieważ jest to framework przeznaczony do pracy z API REST. Interfejs API WordPress zawiera łatwy w obsłudze interfejs API Javascript oparty na modelach szkieletowych. Dzięki temu twórcy wtyczek i motywów mogą rozpocząć pracę bez konieczności nadmiernego wysiłku i wiedzy na temat szczegółów nawiązywania połączenia.

Jest tego o wiele więcej, ale Backbone nadaje strukturę aplikacjom internetowym, udostępniając modele, kolekcje i widoki, a następnie łączy to wszystko z API WordPress za pośrednictwem interfejsu REST JSON.

logo znaku słownego backbone.js

Co to oznacza dla programistów WordPressa?

Wraz z dostępnością API WordPress, pojawiło się coraz więcej nowych sposobów jego wykorzystania i będzie tak dalej, wraz ze wzrostem jego popularności. Interfejs API WordPress może ulepszyć niemal każdą istniejącą funkcjonalność WordPress, która opiera się na JavaScript. Oto kilka przykładów:

  • zatwierdzenie/przesłanie formularza
  • Motywy i wtyczki Backbone.js
  • nieskończone przewijanie

To także świetny sposób na pokazanie treści z innych źródeł. Teraz można łatwo wyświetlać treści z pojedynczej witryny w konfiguracji obejmującej wiele witryn. Możliwe jest również wyświetlanie treści z całkowicie oddzielnej witryny WordPress. Oprócz wyświetlania treści, zawartość można także łatwiej i skuteczniej 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 API i jego możliwości zapewni dobry start podczas odkrywania nowych możliwości API WordPress.