Dasar-dasar API WordPress: Apa artinya dan bagaimana menggunakannya

Diterbitkan: 2016-03-03

Anda mungkin pernah mendengar desas-desus tentang WordPress JSON REST API. Ini adalah berita besar bagi pengguna WordPress dan alasan untuk perayaan!

JSON, REST, API – ini adalah banyak jargon untuk satu nama, jadi mari kita urai semuanya.

Apa itu API?

API adalah singkatan dari “Aplication Programming Interface”, yang merupakan sekumpulan instruksi dan standar pemrograman untuk mengakses aplikasi perangkat lunak berbasis web atau alat web. Bayangkan "perangkat lunak satu" yang memberikan instruksi "perangkat lunak dua". API adalah kesepakatan antara keduanya dan jalur komunikasi terbuka. Pada dasarnya, apa yang mereka katakan satu sama lain adalah sesuatu di sepanjang baris "ketika Anda memberi saya instruksi, saya akan melakukan tindakan, atau mengembalikan informasi yang benar."

Saat kami menelusuri web dan menggunakan berbagai solusi perangkat lunak, kami terbiasa dengan antarmuka pengguna dengan tata letak, tombol, dan grafik tertentu yang berinteraksi dengan kami untuk menyelesaikan tugas yang kami inginkan. Semua ini tidak berguna bagi mesin karena yang mereka pedulikan hanyalah data dan apa yang perlu mereka lakukan dan bagaimana mereka berinteraksi dengannya. API adalah alternatif perangkat lunak untuk "antarmuka pengguna", memberikan instruksi ke perangkat lunak kedua tentang cara mendapatkan data dan tugas spesifik lainnya. Mereka benar-benar tidak terlihat oleh pengguna yang menggunakan aplikasi web, dan hanya antarmuka perangkat lunak-ke-perangkat lunak.

wordpress-api-software-to-software

Contoh API

Memiliki akses ke API merupakan hal yang luar biasa saat Anda mengembangkan aplikasi web. Ketika API dirilis ke publik, itu berarti pengembang menciptakan solusi yang didukung oleh layanan perangkat lunak. Seringkali, mereka menghilangkan kebutuhan untuk menemukan kembali roda untuk banyak tugas, karena mereka telah dibuat.

Contoh API yang bagus adalah Amazon. Amazon merilis API-nya sehingga pengembang dapat memiliki akses mudah ke produk dan informasinya. Memiliki akses ke ini memudahkan untuk memposting tautan ke produk di amazon, dengan harga terbaru dan opsi untuk membeli.

Contoh lain dari API yang berinteraksi adalah pembelian tiket konser. Untuk membeli tiket secara resmi, Anda harus memasukkan informasi kartu kredit Anda. API digunakan untuk mengirim informasi kartu kredit Anda ke aplikasi jarak jauh, yang kemudian memverifikasi bahwa informasi kartu kredit itu benar. Setelah semuanya diperiksa, aplikasi jarak jauh mengirimkan respons kembali ke situs web tiket yang mengatakan tidak apa-apa untuk melanjutkan, di mana Anda telah berhasil membeli tiket. Ketika semua ini terjadi, Anda hanya melihat satu antarmuka, yaitu situs web tiket. Ini adalah proses yang mulus; di balik layar, banyak aplikasi yang bekerja sama menggunakan API, tetapi Anda sebagai pengguna tidak memperhatikan saat tugas diserahkan dari satu aplikasi ke aplikasi lainnya.

API dan WordPress

Amazon dan pembelian tiket adalah contoh yang bagus tentang bagaimana API bekerja bersama, tetapi bagaimana ini berlaku untuk WordPress?
Nah, semua ide yang sama berlaku. Dengan API WordPress, Anda dapat mendorong dan menarik data dari WordPress.

API adalah alat utama yang dapat digunakan pengembang untuk membagikan data dengan mudah dari situs WordPress mereka ke situs web atau aplikasi lain. Secara khusus, API ini memungkinkan Anda melakukan tindakan create , read , update , dan delete (CRUD) pada konten WordPress. Beberapa contoh tipe konten adalah:

  • Postingan
  • Jenis posting khusus
  • halaman
  • Taksonomi
  • Pengguna
  • Media

Apa yang dimaksud dengan REST?

Tidak ada tidur siang atau mendengkur di sini, tetapi REST mengacu pada gaya arsitektur API. REST adalah singkatan dari Representational State Transfer. Ingat bagaimana kami menyebutkan bahwa API memberikan spesifik untuk komunikasi sehingga program dapat berkomunikasi satu sama lain? REST API dirancang sedemikian rupa sehingga menyediakan metode komunikasi yang ringan, yang menghemat bandwidth. WordPress JSON REST API melakukan hal ini, menjadikannya pilihan yang bagus ketika ada volume data yang tinggi.

Kami baru saja menggores permukaan REST; jika Anda ingin mempelajari lebih lanjut, lihat tutorial bermanfaat REST ini.

format JSON

Untuk mengakses data, kita membutuhkan sumber untuk menariknya. Di sinilah JSON masuk. JSON adalah singkatan dari JavaScript Object Notation. JSON mudah dibaca dan dipahami oleh manusia dan mesin. Ini adalah cara sempurna untuk menyimpan informasi dengan cara yang terorganisir dan mudah diakses. Karena JSON sangat mudah diakses, ini membuatnya sangat cocok untuk membuat REST API dan merupakan solusi sempurna untuk WordPress JSON REST API.

Berikut adalah ide dasar tentang seperti apa format JSON:

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

Format JSON di WordPress

JSON tidak hanya menulis sendiri, tetapi jangan khawatir, Anda tidak perlu membuat file JSON secara manual. Ada plugin hebat yang membuatnya untuk Anda. Dengan alat ini, data situs akan berada dalam format yang benar, termasuk pengguna, posting, halaman, taksonomi, dan banyak lagi. Plugin ini dapat ditemukan di sini. Juga, ada beberapa dokumentasi bermanfaat yang akan berharga saat Anda memulai.

wordpress-api

Menggunakan JSON REST API

Menggunakan API cukup jelas; Anda akan mengambil data situs Anda dalam format JSON sederhana. Dan jika Anda telah menginstal plugin, Anda dapat bermain-main dengan melihat posting situs Anda dalam bentuk data.

Mengambil atau memperbarui data semudah mengirim permintaan HTTP. HTTP adalah protokol permintaan/tanggapan. Pertama, Anda mengirim permintaan data dan kemudian data dikirim kembali sebagai respons.

DAPATKAN metode

Metode GET digunakan untuk mengambil informasi dan tidak berpengaruh pada data. Cukup kirim permintaan GET ke /wp-json/wp/v2/posts . Ingin mencari sesuatu? Misalnya, jika Anda mencari "pengembangan", Anda akan mendapatkan hasil dengan permintaan GET /wp-json/wp/v2/posts?search=development .

POST permintaan

Permintaan POST digunakan untuk mengirim data. Dengan kemampuan API baru, misalnya, Anda dapat memperbarui pengguna. Katakanlah Anda ingin memperbarui pengguna dengan ID 10. Yang harus Anda lakukan adalah mengirim permintaan POST ke /wp-json/wp/v2/users/10 .

Untuk mencoba ini, saya sarankan menggunakan Postman, ekstensi Google Chrome.

Lebih banyak Javascript dalam campuran

Backbone.js dan API

Backbone.js adalah cara yang bagus untuk bekerja dengan API karena ini adalah kerangka kerja yang dirancang untuk bekerja dengan REST API. WordPress API menyertakan Javascript API yang mudah digunakan berdasarkan model Backbone. Ini memungkinkan pengembang plugin dan tema untuk bangun dan berjalan tanpa upaya dan pengetahuan yang sangat mendalam tentang detail untuk terhubung. Ada lebih banyak lagi, tetapi Backbone memberikan struktur pada aplikasi web dengan menyediakan model, koleksi, dan tampilan, dan menghubungkan semuanya ke API WordPress melalui antarmuka REST JSON.

wordpress-api-backbone

Apa artinya semua ini bagi pengembang WordPress?

Dengan ketersediaan API WordPress, cara baru untuk menggunakannya telah meningkat dan akan terus meningkat seiring popularitasnya. API WordPress dapat meningkatkan hampir semua fungsionalitas WordPress yang ada yang bergantung pada Javascript. Berikut adalah beberapa contoh:

  • validasi/pengiriman formulir
  • Tema atau plugin Backbone.js
  • pengguliran tak terbatas

Ini juga merupakan cara yang bagus untuk menampilkan konten dari sumber lain. Sekarang, mudah untuk menampilkan konten dari situs individual dalam pengaturan multisitus. Anda juga dapat menampilkan konten dari situs WordPress yang sepenuhnya terpisah. Selain menampilkan konten, konten juga dapat diperbarui.

Sekarang setelah kita membahas beberapa terminologi dasar, kita tahu bahwa JSON adalah notasinya, REST adalah gaya arsitekturnya, dan API adalah antarmuka yang mereka buat. Mengetahui dasar-dasar API dan kemampuannya akan memastikan Anda memulai dengan awal yang baik saat menjelajahi kemungkinan baru dengan API WordPress.