Khu Vực

Các API về khu vực cho phép bạn xem danh sách các Mã Định Danh và tên Tỉnh/Thành phố, Quận/Huyện, Phường/Xã tương ứng.

Lấy Thông Tin Tỉnh/Thành Phố

API này cho phép bạn lấy danh sách các Mã Định Danh và tên Tỉnh/Thành phố tương ứng.

Endpoint

get/v1/platform/areas/province

Request

Ví Dụ

curl --location --request GET 'https://dev.superai.vn/v1/platform/areas/province'

Response

Tham Số Trả Về

Thuộc_Tính	Kiểu_DL	Mô_Tả_Chi_Tiết
code	String	Mã Tỉnh/Thành Phố. Ví dụ: 79.
name	String	Tên Tỉnh/Thành Phố. Ví dụ: Thành phố Hồ Chí Minh.

Ví Dụ

{
    "error": false,
    "message": "",
    "data": [
		{
            "code": "79",
            "name": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "01",
            "name": "Thành phố Hà Nội"
        },
        {
            "code": "31",
            "name": "Thành phố Hải Phòng"
        },
        {
            "code": "89",
            "name": "Tỉnh An Giang"
        }
    ]
}

Lấy Thông Tin Quận/Huyện

API này cho phép bạn lấy danh sách các Mã Định Danh và tên Quận/Huyện tương ứng.

Endpoint

get/v1/platform/areas/district

Request

Các Tham Số

Thuộc_Tính	Bắt_Buộc	Kiểu_DL	Mô_Tả_Chi_Tiết
province	Có	String	Mã Tỉnh/Thành Phố. Ví dụ: 79.

Ví Dụ

curl --location --request GET 'https://dev.superai.vn/v1/platform/areas/district?province=79'

Response

Tham Số Trả Về

Thuộc_Tính	Kiểu_DL	Mô_Tả_Chi_Tiết
code	String	Mã Quận/Huyện. Ví dụ: 785.
name	String	Tên Quận/Huyện. Ví dụ: Huyện Bình Chánh.
province	String	Tên Tỉnh/Thành Phố. Ví dụ: Thành phố Hồ Chí Minh.

Ví Dụ

{
    "error": false,
    "message": "",
    "data": [
        {
            "code": "760",
            "name": "Quận 1",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "771",
            "name": "Quận 10",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "772",
            "name": "Quận 11",
            "province": "Thành phố Hồ Chí Minh"
        }
    ]
}

Lấy Thông Tin Phường/Xã

API này cho phép bạn lấy danh sách các Mã Định Danh và tên Phường/Xã tương ứng.

Endpoint

get/v1/platform/areas/commune

Request

Các Tham Số

Thuộc_Tính	Bắt_Buộc	Kiểu_DL	Mô_Tả_Chi_Tiết
district	Có	String	Mã Quận/Huyện Phố. Ví dụ: 767.

Ví Dụ

curl --location --request GET 'https://dev.superai.vn/v1/platform/areas/commune?district=777'

Response

Tham Số Trả Về

Thuộc_Tính	Kiểu_DL	Mô_Tả_Chi_Tiết
code	String	Mã Phường/Xã. Ví dụ: 27037.
name	String	Tên Phường/Xã. Ví dụ: Phường Hiệp Tân.
district	String	Tên Quận/Huyện. Ví dụ: Quận Tân Phú.
province	String	Tên Tỉnh/Thành Phố. Ví dụ: Thành phố Hồ Chí Minh.

Ví Dụ

{
    "error": false,
    "message": "",
    "data": [
        {
            "code": "27460",
            "name": "Phường An Lạc",
            "district": "Quận Bình Tân",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27463",
            "name": "Phường An Lạc A",
            "district": "Quận Bình Tân",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27436",
            "name": "Phường Bình Hưng Hòa",
            "district": "Quận Bình Tân",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27439",
            "name": "Phường Bình Hưng Hoà A",
            "district": "Quận Bình Tân",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27442",
            "name": "Phường Bình Hưng Hoà B",
            "district": "Quận Bình Tân",
            "province": "Thành phố Hồ Chí Minh"
        }
    ]
}