API Províncias de Angola

Províncias

Introdução

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

https://angolaprovinciasapi.ao/api/v2

Buscando todas as províncias

Este endpoint retorna as informações sobre todas as províncias:

GET /provinces

Exemplo de consulta:

GET https://www.angolaprovinciasapi.oamaralsalgado.ao/api/v2/provinces

{ "success": true, "code": 200, "message": "Sucesso", "data": [ { "name": "Luanda", "slug": "luanda", "area": 113, "founded_at": "1576-01-25", "capital": { "name": "Ingombota", "slug": "ingombota" }, "municipalities": [ { "name": "Belas", "slug": "belas", "districts": [], "communes": [ { "name": "Benfica", "slug": "benfica" } ] } ], "ethnic_groups": [ { "name": "Ambundu", "slug": "ambundu" } ], "languages": [ { "name": "Kimbundu", "slug": "kimbundu" } ] } ] }

Buscando informações sobre uma determinada província

Este endpoint retorna as informações sobre uma determinada província:

GET /provinces/{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 /provinces , 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://www.angolaprovinciasapi.oamaralsalgado.ao/api/v2/provinces/uige

{ "success": true, "code": 200, "message": "Sucesso", "data": { "name": "Uíge", "slug": "uige", "area": 58698, "founded_at": "1887-05-31", "capital": { "name": "Uíge", "slug": "uige" }, "municipalities": [ { "name": "Maquela do Zombo", "slug": "maquela-do-zombo", "districts": [], "communes": [ { "name": "Maquela do Zombo", "slug": "maquela-do-zombo" } ] } ], "ethnic_groups": [ { "name": "Ambundu", "slug": "ambundu" } ], "languages": [ { "name": "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. A seguir, explicamos como você pode consultar cada uma dessas informações de uma província utilizando a api.

Capital

Para consultar a capital de uma província específica, utilize o seguinte endpoint:

GET /provinces/{slug}/capital

Exemplo de consulta:

GET https://www.angolaprovinciasapi.oamaralsalgado.ao/api/v2/provinces/bengo/capital

{ "success": true, "code": 200, "message": "Sucesso", "data": { "name": "Dande", "slug": "dande" } }

Saiba mais sobre como buscar as capitais.

Municípios

Para consultar os municípios de uma província, utilize o seguinte endpoint:

GET /provinces/{slug}/municipalities

Exemplo de consulta:

GET https://angolaprovinciasapi.ao/api/v2/provinces/bengo/municipalities

{ "success": true, "code": 200, "message": "Sucesso", "data": [ { "name": "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 /provinces/{slug}/languages

Exemplo de consulta:

GET https://angolaprovinciasapi.ao/api/v2/provinces/lunda-norte/languages

{ "success": true, "code": 200, "message": "Sucesso", "data": [ { "name": "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 /provinces/{slug}/ethnic-groups

Exemplo de consulta:

GET https://angolaprovinciasapi.ao/api/v2/provinces/zaire/ethnic-groups

{ "success": true, "code": 200, "message": "Sucesso", "data": [ { "name": "Bakongo", "slug": "bakongo" } ] }

Saiba mais sobre como buscar as etnias.