API Províncias de Angola

Comunas

Introdução

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

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

Buscando todas as comunas do país

Este endpoint retorna as informações sobre todas as comunas do país:

GET /comunas

Exemplo de consulta:

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/comunas
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
{
"nome": "Bela Vista",
"slug": "bela-vista",
"municipio": {
"nome": "Ambriz",
"slug": "ambriz",
"provincia": {
"nome": "Bengo",
"slug": "bengo",
"extensao": "31.371 km²",
"data_fundacao": "26-04-1980"
}
}
},
//...
]
}

Buscando uma determinada comuna

Para consultar uma determinada comuna, utilize o seguinte endpoint:

GET /comunas/{slug}

{slug} deve ser substituído pelo slug da comuna.

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

Exemplo de consulta:

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/comunas/bela-vista
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": {
"nome": "Bela Vista",
"slug": "bela-vista",
"municipio": {
"nome": "Ambriz",
"slug": "ambriz",
"provincia": {
"nome": "Bengo",
"slug": "bengo",
"extensao": "31.371 km²",
"data_fundacao": "26-04-1980"
}
}
}
}