wenova-address

Address plugin SDK for WENOVA Link (Province, District, Village).

Use this package to connect your app to WENOVA Link Address data.

If you want to start using this service, please visit https://microservices.wenova.fun/.

Note: pluginKey is required.

Installation

npm i wenova-address

Usage

const {
  getProvinces,
  getProvinceById,
  getDistrictsByProvince,
  getDistrictById,
  getVillagesByDistrict,
  getVillageById,
} = require('wenova-address');

async function run() {
  const pluginKey = 'your-key';

  // 1) Connect and get provinces
  const provinces = await getProvinces({ pluginKey, kw: 'vien' });
  console.log('provinces', provinces);

  // 2) Get province detail
  const province = await getProvinceById(1, { pluginKey });
  console.log('province', province);

  // 3) Get districts from selected province
  const districts = await getDistrictsByProvince(1, { pluginKey, kw: 'chan' });
  console.log('districts', districts);

  // 4) Get district detail
  const district = await getDistrictById(1, { pluginKey });
  console.log('district', district);

  // 5) Get villages from selected district
  const villages = await getVillagesByDistrict(1, { pluginKey, kw: 'ban' });
  console.log('villages', villages);

  // 6) Get village detail
  const village = await getVillageById(1, { pluginKey });
  console.log('village', village);
}

run().catch(console.error);

Quick guide

• Put your pluginKey in each call
• Optional: set baseUrl when needed
• Use search keyword via kw
• Use ID from previous response to fetch detail

Available functions

• getProvinces({ pluginKey, kw?, baseUrl? })
• getProvinceById(id, { pluginKey, baseUrl? })
• getDistrictsByProvince(provinceId, { pluginKey, kw?, baseUrl? })
• getDistrictById(id, { pluginKey, baseUrl? })
• getVillagesByDistrict(districtId, { pluginKey, kw?, baseUrl? })
• getVillageById(id, { pluginKey, baseUrl? })

All functions return Promise data.

Error handling

Throws Error when:

• request failed
• pluginKey is missing
• id / provinceId / districtId is invalid