Dokumentasi API Alamat di Indonesia

Indonesia memiliki 5 tingkat daerah pengalamatan yaitu provinsi, kabupaten atau kota, kecamatan, dan desa atau kelurahan.

Saking banyaknya jenis alamat ini, bisa jadi membingungkan untuk beberapa pendatang yang ingin menentukan alamatnya di Indonesia.

Jadi, tujuan API ini dibuat adalah untuk melakukan proses pencarian alamat dengan keyword tertentu sehingga bisa muncul secara lengkap mulai dari provinsi sampai dengan desa / kelurahan.

---

Fitur

API ini memungkinkan untuk menampilkan data alamat hingga kodepos-nya, adapun keunggulan lainnya yaitu

---

Ringan. API ini dibuat dengan menggunakan Seme Framework yang ringan dan cepat.

RDBMS. Database yang telah dioptimasi dengan menggunakan indexing dan fitur cache untuk MariaDB.

JSON. Output API berupa JSON yang simpel dan memudahkan untuk digunakan.

---

Lisensi

Baik API, data, maupun kode yang ada dihalaman ini mematuhi lisensi MIT.

---

Tanya / Jawab

Jika ada pertanyaan dan jawaban, bisa langsung hub saya via instagram, facebook, or atau github.

---

Kode Sumber

Anda bebas untuk mengembangkan versi anda sendiri dengan cara fork reponya di github.

---

Panduan Penggunaan

API ini dapat digunakan secara Gratis tapi tidak ada jaminan bahwa layanan ini akan aktif terus menerus. Pertama-tama URL dasar (API Endpoint)-nya adalah https://alamat.thecloudalert.com/api/.

Semua proses pengambilan data ada setelah Endpoint tersebut.

API Provinsi

Untuk menampilkan list data provinsi yang ada di Indonesia.

Bentuk Umum

GET provinsi/get/

Cara Penggunaan

Contoh cara penggunaan untuk pemanggilan API:

GET https://alamat.thecloudalert.com/api/provinsi/get/

Contoh hasil dari pemanggilan API:

{
  "status": 200,
  "message": "Berhasil",
  "result": [
    {
      "id": "1",
      "text": "Bali"
    },
    {
      "id": "2",
      "text": "Bangka Belitung"
    },
    ...
  ]
}
            

API KabKota

Endpoint API untuk mendapatkan list kabupaten atau kota.

Bentuk Umum

GET kabkota/get/?d_provinsi_id=[ID_DARI_API_PROVINSI]

Cara Penggunaan

Contoh cara penggunaan untuk pemanggilan API:

GET https://alamat.thecloudalert.com/api/kabkota/get/?d_provinsi_id=1

Contoh hasil dari pemanggilan API:

{
  "status": 200,
  "message": "Berhasil",
  "result": [
    {
      "id": "1",
      "text": "Kabupaten Badung"
    },
    {
      "id": "2",
      "text": "Kabupaten Bangli"
    },
    ...
  ]
}
            

API Kecamatan

Endpoint API untuk mendapatkan list kecamatan berdasarkan ID Kabupaten atau Kota.

Bentuk Umum

GET kecamatan/get/?d_kabkota_id=[ID_DARI_API_KABKOTA]

Cara Penggunaan

Contoh cara penggunaan untuk pemanggilan API:

GET https://alamat.thecloudalert.com/api/kecamatan/get/?d_kabkota_id=1

Contoh hasil dari pemanggilan API:

{
  "status": 200,
  "message": "Berhasil",
  "result": [
    {
      "id": "1",
      "text": "Abiansemal"
    },
    {
      "id": "2",
      "text": "Kuta"
    }
  ]
}
            

API DesaKel

Endpoint API untuk mendapatkan list desa atau kelurahan berdasarkan ID dari API Kecamatan.

Bentuk Umum

GET kelurahan/get/?d_kecamatan_id=[ID_DARI_API_KECAMATAN]

Cara Penggunaan

Contoh cara penggunaan untuk pemanggilan API:

GET https://alamat.thecloudalert.com/api/kelurahan/get/?d_kecamatan_id=1

Contoh hasil dari pemanggilan API:

{
  "status": 200,
  "message": "Berhasil",
  "result": [
    {
      "id": "17",
      "text": "Abiansemal"
    },
    {
      "id": "18",
      "text": "Angantaka"
    }
  ]
}

Kodepos

Endpoint API untuk mendapatkan list kodepos berdasarkan ID dari API Kabkota dan ID dari API Kecamatan.

Bentuk Umum

GET kodepos/get/?d_kabkota_id=[ID_DARI_API_KABKOTA]&d_kecamatan_id=[ID_DARI_API_KECAMATAN]

Cara Penggunaan

Contoh cara penggunaan untuk pemanggilan API:

GET https://alamat.thecloudalert.com/api/kodepos/get/?d_kabkota_id=1&d_kecamatan_id=1

Contoh hasil dari pemanggilan API:

{
  "status": 200,
  "message": "Berhasil",
  "result": [
    {
      "id": "3719",
      "text": "29871"
    },
    {
      "id": "3720",
      "text": "29872"
    }
  ]
}
          

API Searching / Filtering

API untuk mencari alamat (provinsi / kabkota / kecamatan / desakel) dengan keyword tertentu.

Bentuk Umum

GET cari/index/?keyword=[KATA_KUNCI_FILTER_PENCARIAN]

Cara Penggunaan

Contoh cara penggunaan untuk pemanggilan API:

GET https://alamat.thecloudalert.com/api/cari/index/?keyword=Soreang

Contoh hasil dari pemanggilan API:

{
  "status": 200,
  "message": "Berhasil",
  "result": [
      "negara": "Indonesia",
      "provinsi": "Jawa Barat",
      "kabkota": "Kabupaten Bandung",
      "kecamatan": "Soreang",
      "desakel": "Bukit Harapan"
    },
    ...
  ]
}