Ketika ingin belajar WordPress lebih jauh, Anda tentu akan bertemu dengan istilah WordPress REST API. Bagian dari core WordPress ini terbukti mampu membuat WordPress berkembang menjadi sebuah platform yang modern dan dinamis.
Nah, di artikel ini, kami akan membahas semua hal tentang WordPress API.
Tak hanya pengertiannya saja, kami juga akan menjelaskan cara kerjanya dan memberikan panduan dasar API WordPress yang mudah dipahami oleh pemula sekalipun.
Tanpa berlama-lama Iagi, yuk mulai!
Apa Itu WordPress REST API?
Sebelum kami jelaskan apa itu REST API, Anda perlu mengetahui pengertian API terlebih dahulu.
API atau Application Programming Interface adalah sebuah interface yang dapat menghubungkan dua aplikasi untuk dapat berkomunikasi dengan mudah. Bisa berupa website, mobile app, web app, atau lainnya.
Anda bisa membayangkan API ini sebagai seorang pelayan di sebuah restoran yang menghubungkan tamu dan koki di dapur.
Nah, WordPress REST API merupakan salah satu jenis API. REST (Representational State Transfer) API memanfaatkan menghubungkan w software melalui HTTP dalam proses pertukaran datanya.
Dengan adanya WordPress API, pengembangan website WordPress bisa lebih mudah karena developer tak perlu membuat aplikasi dengan fungsi dan tujuan yang sama dari nol.
Misalnya, Anda bisa memasang API Google Maps di website. Anda akan mendapatkan semua fitur dan data Google Maps tanpa harus membuat aplikasi peta sendiri.
Nah, sebuah API harus memenuhi syarat di bawah ini agar bisa dianggap RESTful:
- Interface yang seragam — URL yang digunakan untuk mengakses sistem haruslah seragam, konsisten, dan bisa diakses melalui pendekatan umum seperti GET.
- Server dan klien terpisah — Tujuannya agar keduanya bisa dikembangkan secara mandiri. Selain itu, jika ada perubahan di sisi server, aplikasinya tetap bisa diakses oleh cara yang sama.
- Kondisi server tak berubah — Server tetap dalam kondisi yang sama saat ada request baru dari API karena tak perlu menyimpan request tersebut.
- Bisa di cache — Semua sumber daya harus bisa di cache supaya performa tinggi. Baik dari sisi server maupun klien.
- Sistem berlapis — Di antara request klien dan otentikasi dari server, terdapat beberapa lapisan yang memisahkannya. Entah itu lapisan keamanan, lapisan cache, atau lapisan dengan fungsi lainnya.
WP REST API adalah format API yang memungkinkan Anda untuk mengintegrasikan berbagai elemen WordPress dengan aplikasi dan server dari luar menggunakan JSON. Oleh karena itu, Anda perlu mengerti dulu dasar-dasar WordPress, JavaScript dan JSON.
Baca Juga: Webhook: Definisi, Cara Kerja, dan Bedanya dengan API
Manfaat WordPress REST API
Berikut beberapa manfaat WP REST API bagi WordPress secara keseluruhan:
- Membuat tampilan WordPress semakin modern dan ramah untuk pengguna. Contohnya dengan kemunculan Editor Gutenberg.
- Menjadi penghubung yang lebih universal untuk berbagai bahasa pemrograman
- Membuat pengembangan WordPress lebih fleksibel dengan standar sistem yang lebih sederhana
- Mengembangkan website WordPress jadi lebih mudah dengan integrasi konten yang sederhana
- Semakin mudah untuk mendapatkan pilihan aplikasi yang beragam untuk bisa digunakan di WordPress
Cara Kerja WordPress REST API
Sebelum WordPress versi 4.4, Anda harus menggunakan plugin jika ingin mengakses WordPress API. Namun kini, WordPress REST API telah menjadi bagian inti dari WordPress.
Nah, untuk memanggil REST API, ada empat jenis metode HTTP yang bisa Anda gunakan, yaitu:
- GET — Mengambil informasi dari server. Misalnya, saat mengunjungi halaman login wordPress, browser Anda akan mengirimkan permintaan GET ke server. Lalu, server akan yang memprosesnya menggunakan API.
- POST — Mengirim informasi ke server. Misalnya, setelah berhasil masuk ke halaman admin WordPress, Anda akan melakukan permintaan untuk memasukkan data berupa post artikel.
- PUT — Digunakan untuk mengedit dan memperbarui data yang ada. Misalnya, saat Anda ingin mengubah kata sandi.
- DELETE — Dapat digunakan untuk menghapus informasi. Misalnya, saat Anda ingin menghapus akun yang ada di dalam WordPress admin.
Panduan Dasar Menggunakan REST API
Di panduan ini, kami akan menggunakan Command Line Interface (CLI) Windows yaitu Putty. Jika menggunakan MacOS dan Linux, Anda bisa membuka Terminal.
Sebagai langkah awal, salin alamat IP server Anda menggunakan perintah SSH. Namun, kami menyarankan Anda untuk menggunakan situs WordPress demo atau localhost. Jika terjadi error, biar tidak mengganggu website utama Anda.
1. Memahami perintah dasar REST API
Pada panduan ini kami akan menggunakan beberapa perintah REST API sebagai berikut:
- Routes & ENDPOINT: Routes adalah URL yang dapat Anda mapping ke berbagai metode HTTP. Sedangkan Endpoints adalah koneksi antara HTTP. Contohnya adalah /wp-json/ yang berisi semua routes dan endpoints.
- Request: digunakan untuk menyimpan dan mengambil informasi dari sebuah kode WP_REST_Request.
- Responses: perintah ini memberikan data yang Anda minta atau bisa juga memberikan lokasi pesan error. Dengan begitu, Anda tahu di mana letak error yang terjadi.
- Schema: menampilkan daftar properties dan input properties yang dapat diterima dan dikembalikan oleh REST API.
- Controller classes: perintah ini adalah lokasi tempat Anda mengelola REST API.
2. Mengenal perintah ENDPOINT menggunakan WordPress REST API
Pada panduan REST API ini, kami akan menggunakan beberapa ENDPOINT REST API yang dapat Anda coba:
Pertama-tama, Anda harus memanggil HTTP ke REST API dengan cara mengakses browser dan masukkan link berikut:
http://Nama_Domain_Anda.com/wp-json/Kedua, Anda dapat melakukan test koneksi dengan cara menjalankan perintah curl pada command line Anda. Untuk itu, gunakan perintah berikut:
| curl -X OPTIONS -i http://Nama_Domain_Anda.com/wp-json/ |
Output dari perintah di atas adalah tampilan pesan HTTP seperti berikut:
Selanjutnya, Anda dapat mengulangi perintah ini menggunakan beberapa ENDPOINT.
Kali ini, kami akan menggunakan perintah GET dari curl untuk mengambil daftar file JSON dari postingan WordPress Anda. Untuk melakukan perintah GET, Anda dapat menggunakan perintah berikut:
curl -X GET -i http://Nama_Domain_Anda.com/wp-json/wp/v2/postsAtau, Anda juga dapat mencoba perintah ini untuk memeriksa semua halaman yang ada pada website WordPress Anda:
curl -X GET -i http://Nama_Domain_Anda.com/wp-json/wp/v2/pagesPanduan dasar REST API Authentication
Data di dalam WordPress REST API itu bersifat publik. Sementara beberapa situs WordPress mengharuskan Anda untuk masuk sebagai administrator WordPress.
Nah, untuk mengatasi masalah ini, Anda harus mengautentikasikan akun WordPress Anda dengan server.
Tujuannya adalah agar Anda dapat melakukan request apa pun sebagai administrator. Contohnya seperti melihat konten yang tidak dipublikasikan atau update post yang ada di dalam website.
Pada tutorial ini, kami akan menggunakan Plugin WordPress REST API – OAuth. Plugin ini adalah plugin khusus developer yang membantu Anda mempelajari REST API. Tapi, plugin ini tidak ditujukan untuk website live atau online, ya.
Ini dia langkahnya:
- Masuk ke dashboard WordPress Anda dan masuk ke menu Plugin > Add New > search plugin “WP REST API – OAuth“.
- Lalu klik Install dan Activate.
- Setelah WordPress REST API di install, buka CLI dan autentikasi ke REST API dengan menggunakan user WordPress Anda. Berikut adalah contoh cara menerapkan metode autentikasi user, menggunakan curl untuk melihat posting yang tidak dipublikasikan.
curl --user username_WordPress:Password_WordPress -i http://Domain_Anda.com/wp-json/wp/v2/posts?status=draft4. Mencari Post Blog Menggunakan WordPress REST API
Sekarang Anda sudah paham cara melakukan request ke REST API menggunakan perintah curl. Jadi, Anda dapat melanjutkan dengan cara memilih posting WordPress tertentu menggunakan beberapa perintah berikut.
Pertama, lihat semua post di dalam situs WordPress Anda menggunakan perintah berikut:
curl -X GET -i http://Domain_Anda.com/wp-json/wp/v2/postsLalu, Anda akan diberikan tampilan JSON seperti pada gambar di bawah ini. Pilih saja salah satu ID post yang akan Anda lihat.
Kedua, Setelah Anda memilih ID post, kemudian masukkan perintah berikut dengan menambahkan ID post pada akhir perintah curl:
curl -X GET -i http://Domain_Anda.com/wp-json/wp/v2/posts/IDAnda dapat menggunakan perintah di atas untuk memilih ID post, kategori, page, comment, dan lain-lain yang diberikan oleh ENDPOINT untuk WordPress REST API.
5. Memperbarui Judul Post Menggunakan REST API
Kemudian, kami akan meng-update post pada WordPress menggunakan REST API.
Pada panduan ini, kami akan mencoba mengubah nama judul artikel dengan menggunakan perintah POST. Jadi, pastikan Anda menambahkan ID post artikel pada perintah POST, ya!
Selanjutnya, Anda bisa masukkan perintah berikut pada command line. Jangan lupa untuk menyesuaikan dengan ID post dan judul artikel yang ingin Anda ubah.
curl -X POST --user username_WordPress:password_WordPresss http://Nama_Domain.com/wp-json/wp/v2/posts/IDPost -d '{"title":"Judul Blog Baru"}'Setelah itu, pastikan Anda telah berhasil mengubah judul artikel menggunakan post ID yang dipilih. Caranya adalah cek post ID menggunakan perintah berikut:
curl -X GET -i http://DomainAnda.com/wp-json/wp/v2/posts/PostIDDan… Selamat! Anda sudah berhasil belajar panduan dasar menggunakan WordPress REST API. Jika ingin belajar lebih jauh lagi, Anda bisa mempelajarinya pada document REST API.
Kesimpulan
Wow, ternyata REST API mempunyai segudang manfaat bagi website WordPress, ya?
Tak hanya membuat WordPress lebih kaya fitur dan konten, WP REST API juga mempermudah pengembangan WordPress. Sehingga para developer bisa menyuntikan beragam fitur canggih yang mempermudah penggunaan WordPress secara keseluruhan.
Oh ya, walaupun panduan di artikel ini hanyalah dasar-dasarnya saja, kami harap tetap bisa membantu Anda mengenal WordPress REST API lebih mendalam. Terutama dari cara kerjanya dan menggunakan perintah dasarnya pada website Anda sendiri.
Demikianlah pembahasan mengenai panduan WordPress REST API untuk pemula. Semoga artikel ini bermanfaat bagi Anda, ya! Jika memiliki pertanyaan, jangan sungkan untuk meninggalkan pertanyaan pada kolom komentar yang tersedia. Sampai jumpa!
