Download the PHP package basoro/api-wilayah without Composer
On this page you can find all versions of the php package basoro/api-wilayah. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package api-wilayah
API Data Wilayah Indonesia
Repository ini berisi source code untuk generate (REST) API statis berisi data wilayah Indonesia serta perintah untuk mendeploynya ke static hosting Github Page.
Demo: https://emsifa.github.io/api-wilayah-indonesia
Apa yang dimaksud API statis?
API statis adalah API yang endpoint-nya terdiri dari file statis.
Keuntungan API statis?
- Dapat dihosting pada static file hosting seperti Github Page, Netlify, dsb.
- Proses lebih cepat karena tidak membutuhkan server-side scripting.
Bagaimana cara kerjanya?
- Daftar provinsi, kab/kota, kecamatan, kelurahan/desa disimpan pada folder
data
berupa filecsv
(agar mudah diedit). - Kemudian script
generate.php
dijalankan. Script ini akan membaca filecsv
didalam folderdata
, kemudian men-generate ribuan endpoint (file) kedalam folderstatic/api
. - API siap 'dihidangkan'.
Saya mau hosting di Github saya sendiri, bagaimana caranya?
- Klik fork di pojok kanan atas.
- Pada halaman forking, HAPUS CENTANG "Copy the master branch only".
- Klik "Create Fork".
- Setelah selesai di Fork, klik Settings (bukan setting account, tapi setting repository).
- Klik menu "Pages" untuk masuk ke menu pengaturan GitHub Pages.
- Pada menu pengaturan GitHub Pages:
- Pilih Source: Deploy from a Branch
- Branch:
gh-pages
- Direktori:
/root
- Klik Save
- Tunggu beberapa menit (5-10 menitan), kembali ke halaman home repository (https://github.com/usernamekamu/api-wilayah-indonesia).
- Kalau halaman sudah terdeploy, di bagian kanan halaman, akan muncul informasi "Environments". Kalau belum tunggu lagi beberapa menit, lalu refresh.
- Kalau sudah muncul informasi Environmentsnya, klik bagian "🚀 github-pages".
- Di halaman Deployments, klik "View Deployment" untuk melihat halaman yang berhasil terdeploy.
ENDPOINTS
1. Mengambil Daftar Provinsi
Contoh Response:
2. Mengambil Daftar Kab/Kota pada Provinsi Tertentu
Contoh untuk mengambil daftar kab/kota di provinsi Aceh (ID = 11):
Contoh Response:
3. Mengambil Daftar Kecamatan pada Kab/Kota Tertentu
Contoh untuk mengambil daftar kecamatan di Aceh Selatan (ID = 1103):
Contoh Response:
4. Mengambil Daftar Kelurahan pada Kecamatan Tertentu
Contoh untuk mengambil daftar kelurahan di Trumon (ID = 1103010):
Contoh Response:
5. Mengambil Data Provinsi berdasarkan ID Provinsi
Contoh untuk mengambil data provinsi Aceh (ID = 11):
Contoh Response:
6. Mengambil Data Kab/Kota berdasarkan ID Kab/Kota
Contoh untuk mengambil data kabupaten Aceh Selatan (ID = 1103):
Contoh Response:
7. Mengambil Data Kecamatan berdasarkan ID Kecamatan
Contoh untuk mengambil data kecamatan Trumon Timur (ID = 1103011):
Contoh Response:
8. Mengambil Data Kelurahan berdasarkan ID Kelurahan
Contoh untuk mengambil data kelurahan Jambo Dalem (ID = 1103011010):
Contoh Response:
LIMITASI
Karena API ini dihosting di Github Page, Github Page sendiri memberikan batasan bandwith 100GB/bulan. Rata-rata endpoint disini memiliki ukuran 1KB/endpoint, jadi kurang lebih request yang dapat digunakan adalah 100.000.000 request per bulan, atau sekitar 3.000.000 request/hari.
Karena limitasi ini, disarankan untuk hosting API ini di github kamu sendiri.
Untuk lebih detail tentang limitasi Github Page, bisa dilihat disini.