Definición de la API

Funciones de la API

Si tiene alguna duda respecto al uso de las funciones, no dude en ponerse en contacto con nosotros.

Cuando exista una palabra encerrada entre llaves { } querrá decir que es una variable que se debe reemplazar por el valor indicado en cada caso.

En las funciones que obtienen un listado de registros por búsqueda, se debe pasar una palabra clave de al menos 3 caracteres. En caso contrario, sólo se retornarán 5 registros.

Antes de invocar las funciones

Para realizar cualquier llamada a la API, primero debe solicitar un token y enviarlo junto con cada solicitud. Un mismo token puede ser usado durante 5 minutos. Transcurridos esos minutos, se deberá solicitar un nuevo token.

La petición de token se realiza mediante la siguiente llamada, utilizando la clave de API que recibió de parte nuestra:

https://www.mundapi.cl/api/Auth/{apiKey}

Se recibirá el valor del token como una propiedad de un objeto JSON:

{
    "data": token
}

Luego, para cada llamada a la API, se debe incluir el siguiente encabezado:

Authorization: Bearer {token}
Content-Type: application/json

Endpoint

https://www.mundapi.cl/api/Geo/Country/{country:int}

Obtiene la información del país cuya identificación viene dada por la parámetro country, de tipo entero.

Ejemplo

URL de Llamada

https://www.mundapi.cl/api/Geo/Country/44

Resultado

{
    "Id": 44,
    "EnglishName": "Chile",
    "NativeName": "Chile",
    "Area": "South America",
    "Capital": "Santiago",
    "Iso2": "CL",
    "Iso3": "CHL",
    "Latitude": -30,
    "Longitude": -71,
    "PhonePrefix": "56",
    "TopLevelDomain": ".cl",
    "Code": 152
}

Endpoint

https://www.mundapi.cl/api/Geo/Country/{language}/{country:int}

Obtiene el nombre del país, cuya identificación viene dada por la parámetro country de tipo entero, traducido al idioma cuyo código estándar es language.

Los idiomas habilitados son: br -> Portugués (Brasil), cn -> Chino, de -> Alemán, es -> Español, fa -> Persa, fr -> Francés, hr -> Croata, it -> Italiano, ja -> Japonés, kr -> Coreano, nl -> Holandés y pt -> Portugués (Portugal).

Ejemplo

URL de Llamada

https://www.mundapi.cl/api/Geo/Country/cn/44

Resultado

"智利"

Endpoints

https://www.mundapi.cl/api/Geo/Countries/Full/{search}

https://www.mundapi.cl/api/Geo/Countries/{search}

Obtiene el listado de países cuyos nombres contengan la palabra clave search.

Ejemplo 1

URL de Llamada

https://www.mundapi.cl/api/Geo/Countries/Full/chi

Resultado

[
  {
    "Id": 44,
    "EnglishName": "Chile",
    "NativeName": "Chile",
    "Area": "South America",
    "Capital": "Santiago",
    "Iso2": "CL",
    "Iso3": "CHL",
    "Latitude": -30,
    "Longitude": -71,
    "PhonePrefix": "56",
    "TopLevelDomain": ".cl",
    "Code": 152
  },
  {
    "Id": 45,
    "EnglishName": "China",
    "NativeName": "中国",
    "Area": "Eastern Asia",
    "Capital": "Beijing",
    "Iso2": "CN",
    "Iso3": "CHN",
    "Latitude": 35,
    "Longitude": 105,
    "PhonePrefix": "86",
    "TopLevelDomain": ".cn",
    "Code": 156
  }
]

Ejemplo 2

URL de Llamada

https://www.mundapi.cl/api/Geo/Countries/chi

Resultado

[
  {
    "Id": 44,
    "Name": "Chile"
  },
  {
    "Id": 45,
    "Name": "China"
  }
]

Endpoint

https://www.mundapi.cl/api/Geo/Country/{country:int}/TimeZones/{search}

Obtiene los husos horarios del país dado por el identificador country, de tipo entero, cuyos nombres contengan la palabra clave search. En este caso, la palabra clave es opcional.

Ejemplo

URL de Llamada

https://www.mundapi.cl/api/Geo/Country/44/TimeZones

Resultado

[
  {
    "Id": 118,
    "Name": "America/Punta_Arenas",
    "Country": "Chile",
    "Offset": "UTC-03:00",
    "Gmt": -10800,
    "Abreviacion": "CLST",
    "Descripcion": "Chile Summer Time"
  },
  {
    "Id": 119,
    "Name": "America/Santiago",
    "Country": "Chile",
    "Offset": "UTC-03:00",
    "Gmt": -10800,
    "Abreviacion": "CLST",
    "Descripcion": "Chile Summer Time"
  },
  {
    "Id": 120,
    "Name": "Pacific/Easter",
    "Country": "Chile",
    "Offset": "UTC-05:00",
    "Gmt": -18000,
    "Abreviacion": "EASST",
    "Descripcion": "Easter Island Summer Time"
  }
]

Endpoint

https://www.mundapi.cl/api/Geo/Country/{country:int}/Currencies/{search}

Obtiene las monedas del país dado por el identificador country, de tipo entero, cuyos nombres contengan la palabra clave search. En este caso, la palabra clave es opcional.

Ejemplo

URL de Llamada

https://www.mundapi.cl/api/Geo/Country/44/Currencies

Resultado

[
  {
    "Id": 46,
    "Name": "CLP",
    "Country": "Chile",
    "Symbol": "$"
  },
  {
    "Id": 253,
    "Name": "UF",
    "Country": "Chile",
    "Symbol": "UF"
  }
]

Endpoint

https://www.mundapi.cl/api/Geo/City/{latitud}/{longitud}

Obtiene la ubicación de la ciudad dadas las coordenadas latitud y longitud, expresadas como números decimales, siendo la coma (,) el separador decimal.

En caso de no coincidir exactamente una coordenada, se retorna la ubicación más próxima.

Ejemplo

URL de Llamada

https://www.mundapi.cl/api/Geo/City/-33,3632483/-70,671604

Resultado

{
  "Continente": {
    "Id": 21,
    "Nombre": "South America"
  },
  "Pais": {
    "Id": 44,
    "Nombre": "Chile"
  },
  "Estado": {
    "Id": 2780,
    "Nombre": "Región Metropolitana de Santiago"
  },
  "Ciudad": {
    "Id": 121169,
    "Nombre": "Huechuraba"
  }
}

Endpoint

https://www.mundapi.cl/api/Geo/State/{state:int}

Obtiene la información del estado cuya identificación viene dada por la parámetro state, de tipo entero.

Ejemplo

URL de Llamada

https://www.mundapi.cl/api/Geo/State/2780

Resultado

{
  "Id": 2780,
  "Name": "Región Metropolitana de Santiago",
  "Country": "Chile",
  "Iso": "RM",
  "Latitude": -33.4375545,
  "Longitude": -70.6504896
}

Endpoints

https://www.mundapi.cl/api/Geo/Country/{country:int}/States/Full/{search}

https://www.mundapi.cl/api/Geo/Country/{country:int}/States/{search}

Obtiene el listado de estados cuyos nombres contengan la palabra clave search perteneciente al país identificado por country.

En caso de necesitar todos los estados, independiente del país, el parámetro country debe ser 0.

Ejemplo 1

URL de Llamada

https://www.mundapi.cl/api/Geo/Country/44/States/Full/par

Resultado

[
  {
    "Id": 2785,
    "Name": "Arica y Parinacota",
    "Country": "Chile",
    "Iso": "AP",
    "Latitude": -18.5940485,
    "Longitude": -69.4784541
  },
  {
    "Id": 2786,
    "Name": "Valparaíso",
    "Country": "Chile",
    "Iso": "VS",
    "Latitude": -33.047238,
    "Longitude": -71.6126885
  }
]

Ejemplo 2

URL de Llamada

https://www.mundapi.cl/api/Geo/Country/44/States/par

Resultado

[
  {
    "Id": 2785,
    "Name": "Arica y Parinacota"
  },
  {
    "Id": 2786,
    "Name": "Valparaíso"
  }
]

Endpoint

https://www.mundapi.cl/api/Geo/City/{city:int}

Obtiene la información de la ciudad cuya identificación viene dada por la parámetro city, de tipo entero.

Ejemplo

URL de Llamada

https://www.mundapi.cl/api/Geo/City/121169

Resultado

{
  "Id": 121169,
  "Name": "Huechuraba",
  "State": "Región Metropolitana de Santiago",
  "Latitude": -33.3692827,
  "Longitude": -70.6648265
}

Endpoints

https://www.mundapi.cl/api/Geo/Country/{country:int}/State/{state:int}/Cities/Full/{search}

https://www.mundapi.cl/api/Geo/Country/{country:int}/State/{state:int}/Cities/{search}

Obtiene el listado de ciudades cuyos nombres contengan la palabra clave search perteneciente al estado identificado por state y al país identificado por country.

En caso de necesitar todas las ciudades de un país, independiente del estado, el parámetro state debe ser 0.

En caso de necesitar todas las ciudades, independiente del país, el parámetro country debe ser 0.

Ejemplo 1

URL de Llamada

https://www.mundapi.cl/api/Geo/Country/44/State/2780/Cities/Full/hue

Resultado

[
  {
    "Id": 121133,
    "Name": "Alhué",
    "State": "Región Metropolitana de Santiago",
    "Latitude": -34.03333333,
    "Longitude": -71.1
  },
  {
    "Id": 121169,
    "Name": "Huechuraba",
    "State": "Región Metropolitana de Santiago",
    "Latitude": -33.3692827,
    "Longitude": -70.6648265
  },
  {
    "Id": 121170,
    "Name": "Pudahuel",
    "State": "Región Metropolitana de Santiago",
    "Latitude": -33.4188359,
    "Longitude": -70.9146307
  }
]

Ejemplo 2

URL de Llamada

https://www.mundapi.cl/api/Geo/Country/44/State/2780/Cities/hue

Resultado

[
  {
    "Id": 121133,
    "Name": "Alhué"
  },
  {
    "Id": 121169,
    "Name": "Huechuraba"
  },
  {
    "Id": 121170,
    "Name": "Pudahuel"
  }
]

Endpoint

https://www.mundapi.cl/api/Geo/Area/{area:int}

Obtiene la información de un área geográfica (continente o subcontinente) cuya identificación viene dada por la parámetro area, de tipo entero.

Ejemplo

URL de Llamada

https://www.mundapi.cl/api/Geo/Area/21

Resultado

{
  "Id": 21,
  "Name": "South America",
  "Countries": 15,
  "Ubicacion": "Americas"
}