API Províncias de Angola

GitHub

Municípios

Introdução

Todas as requisições à API começam com a seguinte URL base: 

https://angolaprovinciasapi.ggwp.com.br/api/v1

Buscando todos os municípios do país

Este endpoint retorna as informações sobre todos os municípios do país: 

GET /municipios

Exemplo de consulta: 

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/municipios
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
{
"nome": "Gabela",
"slug": "gabela",
"provincia": {
"nome": "Cuanza Sul",
"slug": "cuanza-sul",
"extensao": "55.660 km²",
"data_fundacao": "15-09-1917"
}
},
//...
]
}

Buscando um determinado município

Este endpoint retorna as informações sobre um determinado município: 

GET /municipios/{slug}

{slug} deve ser substituído pelo slug do município.

As informações de cada município podem ser acessadas através de um slug exclusivo que identifica o município. O slug está disponível na resposta da requisição que lista todas os municípios. Quando você faz uma requisição por ex. GET /municipios, a API no índice "data" retorna um array de objetos, e cada objeto contém o slug correspondente ao município.

Exemplo de consulta: 

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/municipios/cacongo
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": {
"nome": "Cacongo",
"slug": "cacongo",
"provincia": {
"nome": "Cabinda",
"slug": "cabinda",
"extensao": "7.283 km²",
"data_fundacao": "28-02-1868"
}
}
}

Buscando os distritos de um município

Para consultar os distritos de um município, utilize o seguinte endpoint: 

GET /municipios/{slug}/distritos

{slug} deve ser substituído pelo slug do município.

As informações de cada município podem ser acessadas através de um slug exclusivo que identifica o município. O slug está disponível na resposta da requisição que lista todas os municípios. Quando você faz uma requisição por ex. GET /municipios, a API no índice "data" retorna um array de objetos, e cada objeto contém o slug correspondente ao município.

Exemplo de consulta: 

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/municipios/talatona/distritos
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
{
"nome": "Benfica",
"slug": "benfica"
},
//...
]
}

Saiba mais sobre como buscar distritos.

Buscando as comunas de um muncípio

Para consultar as comunas de um município, utilize o seguinte endpoint: 

GET /municipios/{slug}/comunas

{slug} deve ser substituído pelo slug do município.

As informações de cada município podem ser acessadas através de um slug exclusivo que identifica o município. O slug está disponível na resposta da requisição que lista todas os municípios. Quando você faz uma requisição por ex. GET /municipios, a API no índice "data" retorna um array de objetos, e cada objeto contém o slug correspondente ao município.

Exemplo de consulta: 

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/municipios/talatona/comunas
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
{
"nome": "Mussulo",
"slug": "mussulo"
}
]
}

Saiba mais sobre como buscar comunas.