Api: División Político Administrativa

Descripción

Está Api te permitirá obtener la División Político Administrativa de Chile.

La Api está dividida en 3 secciones principales: Regiones, Provincias y Comunas.

Recursos

Cada consulta a la api retorna uno o más recursos de tipo "sector". Estos recursos tienen la siguiente estructura independiente del sector que se quiera obtener.

Recurso Sector:
Propiedad Tipo Descripción
codigo string Código interno del sector
tipo string Tipo de sector, estos pueden ser: region, provincia y comuna
nombre string Nombre del sector
lat string Latitud de la posición geográfica del sector. (Se puede ocultar con el parámetro "geolocation")
lng string Longitud de la posición geográfica del sector. (Se puede ocultar con el parámetro "geolocation")
url string Url del sitio oficial del sector
codigo_padre string Código del sector padre

Regiones

Las regiones son la base de la División Político Administrativa de Chile

Métodos
Url Tipo Descripción
https://apis.modernizacion.cl/dpa/regiones Lista Listado de las regiones
https://apis.modernizacion.cl/dpa/regiones/{codigo} Sector Representación de una única Región

Provincias

Las provincias son el nivel siguente a la Región. Es posible acceder a ellas directamente o mediante su Región padre

Métodos
Url Tipo Descripción
https://apis.modernizacion.cl/dpa/provincias Lista Listado de las Provincias
https://apis.modernizacion.cl/dpa/provincias/{codigo} Sector Representación de una única Provincia
https://apis.modernizacion.cl/dpa/regiones/{codigo}/provincias Lista Listado de las Provincias pertenecientes a una Región
https://apis.modernizacion.cl/dpa/regiones/{codigo}/provincias/{codigo} Sector Representación de una única Provincia perteneciente a una Región

Comunas

Las comunas son el nivel inferior de la División Político Administrativa que maneja la Api. Existen multiples formas de acceder a ellas

Métodos
Url Tipo Descripción
https://apis.modernizacion.cl/dpa/comunas Lista Listado de las Comunas.
https://apis.modernizacion.cl/dpa/comunas/{codigo} Sector Representación de una única Comuna
https://apis.modernizacion.cl/dpa/provincias/{codigo}/comunas Lista Listado de las Comunas pertenecientes a una Provincia
https://apis.modernizacion.cl/dpa/provincias/{codigo}/comunas/{codigo} Sector Representación de una única Comuna perteneciente a una Provincia
https://apis.modernizacion.cl/dpa/regiones/{codigo}/comunas Lista Listado de las Comunas pertenecientes a una Región
https://apis.modernizacion.cl/dpa/regiones/{codigo}/comunas/{codigo} Sector Representación de una única Comuna perteneciente a una Región
https://apis.modernizacion.cl/dpa/regiones/{codigo}/provincias/{codigo}/comunas Lista Listado de las Comunas pertenecientes a una Provincia que a su vez pertenece a una Región
https://apis.modernizacion.cl/dpa/regiones/{codigo}/provincias/{codigo}/comunas/{codigo} Sector Representación de una única Comuna perteneciente a una Provincia que a su vez pertenece a una Región

Opciones

Las siguientes opciones pueden se usadas como complemento a los metodos ya mencionados

Paginación

Es posible realizar paginaciónes a los metodos de tipo lista mediante los parámetros "limit" y "offset"

limit [numeric]

El parámetro limit especifica la cantidad máxima de sectores a obtener para los metodos de tipo "lista"

https://apis.modernizacion.cl/dpa/regiones?limit=5

Se obtendrán las primeras 5 Regiones encontradas por la Api
offset [numeric]

El parámetro offset especifica limite inferior que se utilizará al obtener los sectores para los metodos de tipo "lista"

https://apis.modernizacion.cl/dpa/regiones?limit=5&offset=5

Se obtendrán 5 Regiones a partir de la 5° Región encontrada por la Api

Ordenamiento

orderBy [string], dafault [nombre]*

Propiedad que se usará para ordenar los recursos obtenidos.

https://apis.modernizacion.cl/dpa/regiones?orderBy=lat
*Las Regiones por defecto se ordenan usando la propiedad [lat]
orderDir [string], default [asc]*

Propiedad que se usará para definir la dirección del ordenamiento Los posibles valores a usar son [asc] y [desc].

https://apis.modernizacion.cl/dpa/regiones?orderBy=lat&orderDir=desc
*Las Regiones por defecto se ordenan en dirección descendente [desc]

Geolocalización

geolocation [boolean]

Mediante el parámetro "geolocation" es posible ocultar las propiedades "lat" y "lng" del sector

https://apis.modernizacion.cl/dpa/comunas/01101?geolocation=false

Jsonp (Callback)

callback [string]

Es posible usar la api mediante Jsonp para incluirla directamente en tus aplicaciones

https://apis.modernizacion.cl/dpa/provincias?callback={string}