API Províncias de Angola
Províncias
Introdução
Todas as requisições à API começam com a seguinte URL base:
https://angolaprovinciasapi.ggwp.com.br/api/v1
Buscando todas as províncias
Este endpoint retorna as informações sobre todas as províncias:
GET /provincias
Exemplo de consulta:
// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
{
"nome": "Luanda",
"slug": "luanda",
"extensao": "18.826 km²",
"data_fundacao": "25-01-1576",
"capital": {
"nome": "Luanda",
"slug": "luanda"
},
"municipios": [
{
"nome": "Talatona",
"slug": "talatona",
"distritos": [
{
"nome": "Benfica",
"slug": "benfica"
},
//...
],
"comunas": [
{
"nome": "Mussulo",
"slug": "mussulo"
},
//...
]
},
],
"etnias": [
{
"nome": "Ambundu",
"slug": "ambundu"
},
//...
],
"linguas": [
{
"nome": "Kimbundu",
"slug": "kimbundu"
},
//...
]
},
//...
]
}
Buscando informações sobre uma determinada província
Este endpoint retorna as informações sobre uma determinada província:
GET /provincias/{slug}
{slug} deve ser substituído pelo slug da província.
As informações de cada província podem ser acessadas através de um slug exclusivo que identifica a província. O slug está disponível na resposta da requisição que lista todas as províncias. Quando você faz uma requisição por ex. GET /provincias, a API no índice "data" retorna um array de objetos, e cada objeto contém o slug correspondente à província.
Segue como exemplo de consulta, buscando informações da província do Uíge:
// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias/uige
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": {
"nome": "Uíge",
"slug": "uige",
"extensao": "58.698 km²",
"data_fundacao": "31-05-1887",
"capital": {
"nome": "Uíge",
"slug": "uige"
},
"municipios": [
{
"nome": "Maquela do Zombo",
"slug": "maquela-do-zombo",
"distritos": [],
"comunas": [
{
"nome": "Maquela do Zombo",
"slug": "maquela-do-zombo"
},
//...
]
},
//...
],
"etnias": [
{
"nome": "Ambundu",
"slug": "ambundu"
},
//...
],
"linguas": [
{
"nome": "Kikongo",
"slug": "kikongo"
},
//...
]
}
}
Buscando informações específicas
A API permite que você acesse uma variedade de informações sobre qualquer província de forma detalhada, utilizando endpoints específicos. Para consultar dados como a capital, municípios, comunas, distritos, línguas e etnias de uma província, você deve utilizar o slug da província na URL correspondente. O slug identifica unicamente cada província e pode ser obtido nas respostas das requisições à api.v1. A seguir, explicamos como você pode consultar cada uma dessas informações de uma província utilizando a api.v1.
Capital
Para consultar a capital de uma província específica, utilize o seguinte endpoint:
GET /provincias/{slug}/capital
Exemplo de consulta:
// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias/bengo/capital
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": {
"nome": "Caxito",
"slug": "caxito"
}
}
Saiba mais sobre como buscar as capitais.
Municípios
Para consultar os municípios de uma província, utilize o seguinte endpoint:
GET /provincias/{slug}/municipios
Exemplo de consulta:
// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias/bengo/municipios
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
{
"nome": "Ambriz",
"slug": "ambriz"
},
//...
]
}
Saiba mais sobre como buscar os municípios.
Línguas
Para consultar as línguas faladas de uma província, utilize o seguinte endpoint:
GET /provincias/{slug}/linguas
Exemplo de consulta:
// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias/lunda-norte/linguas
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
{
"nome": "Cokwe",
"slug": "cokwe"
}
]
}
Saiba mais sobre como buscar as línguas.
Etnias
Para consultar as etnias presentes em uma província, utilize o seguinte endpoint:
GET /provincias/{slug}/etnias
Exemplo de consulta:
// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias/zaire/etnias
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
{
"nome": "Bakongo",
"slug": "bakongo"
}
]
}
Saiba mais sobre como buscar as etnias.