Base url: https://growfie-api.cyclic.app.
Semua request memerlukan autentikasi berupa bearer token. Simpan bearer token tersebut dalam headers seperti berikut:
headers: {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
}
Ganti <TOKEN> dengan token yang telah disediakan oleh tim Back-End.
- RUTE-RUTE UNTUK ADMIN
- RUTE UNTUK KATEGORI
- RUTE-RUTE UNTUK MENGELOLA ARTIKEL
- RUTE-RUTE UNTUK MENGELOLA SARAN PRODUK (BUDGETING)
Digunakan agar dapat mengakses rute-rute lanjutan dengan syarat login menggunakan akun yang telah terdaftar. Kirimkan request dengan body seperti berikut:
body: {
"username": "username_akun",
"password": "password_akun"
}
Ganti masing-masing username_akun dan password_akun dengan yang telah terdaftar.
Jika response berstatus sukses, untuk mempermudah sistem login maka sisi Client/Front-End perlu menyimpan informasi user login tersebut dalam web storage.
Ganti :username dengan nilai username yang dimiliki pada akun target. Digunakan untuk memperbarui data akun.
Lakukan request dengan method put dan sertakan nilai-nilai berikut pada body, contoh:
body: {
"name": "Growth Familie",
"email": "growfie@example.com",
"currentPassword": "password_lama",
"newPassword": "password_baru"
}
PENTING! NILAI-NILAI BERIKUT WAJIB DIISI
- name - nama lengkap pengguna
- currentPassword - masukkan password saat ini / password lama, jika tidak sesuai maka update gagal
- newPassword - masukkan password baru, pastikan tidak memiliki white space dan lebih dari 8 karakter
Untuk saat ini tidak dapat melakukan pembaruan terhadap nilai username.
Ganti :username dengan username yang dimiliki pada akun target.
Digunakan untuk melihat detail akun.
Digunakan untuk mendapatkan semua daftar kategori yang telah tersedia dan hanya menampilkan id dan nama kategori. Adapun kategori yang tersedia adalah:
- Kehamilan
- Bayi
- Balita
- Anak-anak
- Parenting
Digunakan untuk mendapatkan semua artikel yang telah tersedia. Semua artikel tersebut tersimpan dalam array. Contoh nilai yang dikembalikan adalah seperti berikut:
{
"status": "success",
"error": false,
"data": {
"articles": [
{
"id": "636e5996ba0f486fa1445322",
"title": "Perkembangan Bayi 1 Bulan",
"slug": "perkembangan-bayi-1-bulan",
"category": "Bayi",
"img": "https://lh6.googleusercontent.com/bO6teSLkqw0xlb0UqxNQ3zUnAVmp8HlBo9TxKOf4nc5hNiwpwXBijU4xuiA8fxQnSXU=w2400",
"from": "https://www.halodoc.com/artikel/perkembangan-bayi-1-bulan",
"overview": "Halodoc. Setelah berminggu-minggu atau berbulan-bulan menunggu, Si Kecil akhirnya berhasil terlahir ke dunia. Tidak ada kata-kata yang bisa menggam..."
},
{
"id": "636e5a5fba0f486fa1445327",
"title": "Updated: 5 Olahraga untuk Ibu Hamil",
"slug": "5-olahraga-untuk-ibu-hamil",
"category": "Kehamilan",
"img": "https://lh6.googleusercontent.com/LR3IsdrZxLkDVR5a1pt2s5w6m-PPSPYCqsDayGU1BjDkZyeb0FMYEg4fM9_5TaTicVw=w2400",
"from": "https://www.halodoc.com/artikel/5-olahraga-untuk-ibu-hamil",
"overview": "Halodoc. “Ibu hamil juga perlu melakukan olahraga agar kesehatan tetap terjaga dengan baik. Ada berbagai jenis olahraga untuk ibu hamil, seperti be..."
}
]
}
}
Ganti :name dengan satu nama kategori yang telah tersedia. Digunakan untuk mendapatkan semua artikel yang memiliki nama kategori tertentu, jika berhasil maka response yang diberikan sama seperti sebelumnya.
Ganti :slug dengan nilai slug yang dimiliki oleh artikel target. Contoh penggunaannya:
/articles/6-cara-mengatasi-stres-saat-hamil
Contoh response yang dikembalikan jika artikel ditemukan adalah:
{
"status": "success",
"error": false,
"data": {
"article": {
"id": "636e5a4dba0f486fa1445326",
"title": "6 Cara Mengatasi Stres Saat Hamil",
"slug": "6-cara-mengatasi-stres-saat-hamil",
"category": "Kehamilan",
"from": "https://www.halodoc.com/artikel/6-cara-mengatasi-stres-saat-hamil",
"img": "https://lh6.googleusercontent.com/FtgATYHwift_8nfXyO5kYdeKq-IvItcxRaB9sZxw-bWYX6LJPPvbs9BAXR97UI0-LHk=w2400",
"body": "<p><strong><i>Halodoc</i></strong>. Mengalami sedikit stres selama kehamilan adalah hal yang normal. Stres ringan yang terjadi beberapa kali tidak menyebabkan efek negatif pada bayi di dalam kandungan. Namun, jika stres dan cemas kamu terus alami hari demi hari selama kehamilan, mintalah bantuan dokter untuk menangani hal ini.</p><p>Melansir <i>American Pregnancy Association</i>, stres ekstrem yang berkepanjangan bisa berdampak serius. Mulai dari kadar hormon yang berfluktuasi, ketidakpastian tentang masa depan, ketidaknyamanan fisik, atau gangguan mental yang ada sebelumnya. Menemukan cara yang tepat dan sehat untuk mengatasi stres adalah hal penting untuk mengoptimalkan kesehatan calon ibu dan perkembangan bayi.</p>",
"addedBy": "636a53cf514d3b33cc07bff3",
"updatedAt": "2022-11-11T14:21:01.770Z"
}
}
}
Sangat disarankan untuk menggunakan slug dengan alasan lebih mudah dibaca dan dipahami oleh manusia.
Ganti :id dengan id yang dimiliki pada artikel target.
Meskipun tidak disarankan, kami sediakan rute untuk mendapatkan detail artikel menggunakan id. Hasil response yang didapat sama saja seperti menggunakan /articles/:slug. Contoh penggunaan:
/articles/id/636e5a4dba0f486fa1445326
Rute-rute berikut hanya dapat diakses jika telah berhasil login / membutuhkan informasi user terdaftar.
Digunakan untuk menambahkan artikel baru. Lakukan request dan simpan nilai-nilai berikut dalam body, seperti berikut ini:
body: {
"title": "Perkembangan Bayi 7 Bulan",
"category": "Bayi",
"from": "https://www.halodoc.com/artikel/perkembangan-bayi-7-bulan",
"img": "https://lh4.googleusercontent.com/qHV8oKhPv3zIvby_-f0l7ps7uJvlNsUfOg_rc5iefazR4SlTGUzyOyAlpk4rNknLPUE=w2400",
"body": "<p><strong>Halodoc</strong>. Si Kecil sudah berusia genap 7 bulan! Itu artinya ia sudah melewati setengah tahun pertama hidupnya dengan baik. Ayah dan ibu tentunya sudah tidak sabar untuk mengamati perkembangan penting apalagi yang dibuat bayi di usia 7 bulan ini. Karena itu, yuk cari tahu di bawah ini.</p><h2>Bayi Sudah Bisa Merangkak</h2><p>Apakah Si Kecil sudah bisa merangkak? Pertanyaan tersebut seringkali dilontarkan oleh teman-teman atau keluarga, seolah-olah bila bayi belum bisa merangkak di usia 7 bulan itu, artinya ia mengalami keterlambatan perkembangan. Padahal, kenyataannya, rata-rata bayi mulai merangkak di antara usia 6–7 bulan. Bayi juga merangkak secara tidak terduga, sehingga banyak ahli anak, bahkan tidak menganggap kemampuan tersebut sebagai tonggak perkembangan bayi yang penting.</p>",
"user": {
"id": "12345",
"username": "growfie",
"name": "Growth Familie",
"email": "growthfamilie@gmail.com"
}
}
PENTING! NILAI-NILAI BERIKUT WAJIB DIISI
- title - isikan dengan judul artikel
- category - isikan dengan satu kategori yang tersedia
- img - isikan dengan alamat dari gambar yang berkaitan dengan isi artikel
- body - isi atau text konten beserta tag HTML pembungkus kontennya
- user - data pengguna yang berhasil login, tersimpan pada sisi client dalam web storage
NILAI BERIKUT INI BERSIFAT OPTIONAL
- from - jika artikel berasal dari sumber lain maka wajib menyertakan sumber asli pada bagian ini, tapi jika artikel adalah original bisa dikosongkan saja karena akan terisi otomatis dengan nilai username yang melakukan request-nya.
Ganti :slug dengan slug yang dimiliki pada artikel target. Digunakan untuk memperbarui satu artikel yang diperoleh melalui slug. Artikel hanya dapat diperbarui oleh akun yang menambahkan artikel tersebut.
Lakukan request dengan menyertakan nilai-nilai pada body, contoh:
{
"title": "Update: Perkembangan Bayi 7 Bulan",
"category": "Bayi",
"from": "https://www.halodoc.com/artikel/perkembangan-bayi-7-bulan",
"img": "https://lh4.googleusercontent.com/qHV8oKhPv3zIvby_-f0l7ps7uJvlNsUfOg_rc5iefazR4SlTGUzyOyAlpk4rNknLPUE=w2400",
"body": "<p><strong>Halodoc</strong>. Si Kecil sudah berusia genap 7 bulan! Itu artinya ia sudah melewati setengah tahun pertama hidupnya dengan baik. Ayah dan ibu tentunya sudah tidak sabar untuk mengamati perkembangan penting apalagi yang dibuat bayi di usia 7 bulan ini. Karena itu, yuk cari tahu di bawah ini.</p>",
"user": {
"id": "12345",
"username": "growfie",
"name": "Growth Familie",
"email": "growthfamilie@gmail.com"
}
}
Beberapa nilai diatas ada yang wajib diisi dan juga optional sama seperti saat menambahkan artikel.
CATATAN
Meskipun melakukan update terhadap nilai title, nilai slug yang dihasilkan berdasarkan pada nilai title tidak akan ikut diperbarui. Nilai slug hanya akan dihasilkan sekali saja pada saat pertama kali menambahkan artikel, hal ini dibuat dengan pertimbangkan terhadap SEO.
- alternatif untuk /articles/:slug
Ganti :id dengan id yang dimiliki pada artikel target. Digunakan untuk memperbarui satu artikel yang diperoleh melalui id. Artikel hanya dapat diperbarui oleh akun yang menambahkan artikel tersebut.
Ganti :slug dengan slug yang dimiliki pada artikel target. Digunakan untuk menghapus satu artikel berdasarkan pada slug. Artikel hanya dapat dihapus oleh pemilik artikel atau akun yang menambahkan artikel tersebut.
- alternatif untuk /articles/:slug
Ganti :id dengan id yang dimiliki pada artikel target.
Digunakan untuk menghapus satu artikel berdasarkan pada id. Artikel hanya dapat dihapus oleh pemilik artikel atau akun yang menambahkan artikel tersebut.
Rute ini digunakan untuk mendapatkan produk-produk yang disarankan dari semua kategori. Saran produk yang telah tersedia adalah kategori bayi, balita, dan anak-anak.
Ganti :productId dengan id dari satu saran produk tertentu.
Rute ini digunakan untuk melihat satu saran produk saja.
Ganti :name dengan nama kategori yang telah terdaftar.
Rute ini digunakan untuk mendapatkan produk-produk yang disarankan berdasarkan satu kategori tertentu.
Ganti :productId dengan id dari satu saran produk tertentu.
Rute ini digunakan untuk menghapus saran produk dari database berdasarkan pada id-nya.
Rute-rute berikut dapat berfungsi apabila terdapat informasi pengguna yang dikirimkan dan pengguna tersebut terdaftar dan sesuai dengan yang ada di database.
Rute ini digunakan untuk menambahkan satu saran produk baru, dengan contoh format sebagai berikut:
{
"category": "Bayi",
"name": "Popok Besi",
"brand": "Poksi",
"price": "2500000",
"features": "Tahan banting",
"source": "https://popokbesi.com",
"user": {
"id": "636xxxxxxxxxxxxxxxxxxxxx",
"username": "growthfamilie",
"name": "Growth Familie",
"email": "growfie@example.com
}
}
Setiap properti wajib memiliki nilai/tidak boleh kosong. Jika nilai price bertipe string maka akan dikonversi menjadi integer.
Ganti productId dengan id dari satu saran produk tertentu.
Rute ini digunakan untuk memperbarui/update satu saran produk tertentu. Format nilai yang dikirimkan sama seperti contoh untuk menambahkan satu saran produk baru.