API Províncias de Angola

Municípios

Introdução

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

https://angolaprovinciasapi.ao/api/v2

Buscando todos os municípios do país

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

GET /municipalities

Exemplo de consulta:

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

{ "success": true, "code": 200, "message": "Sucesso", "data": [ { "name": "Gabela", "slug": "gabela", "province": { "name": "Cuanza Sul", "slug": "cuanza-sul", "area": 55660, "founded_at": "1914-09-15" } } ] }

Buscando um determinado município

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

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

{ "success": true, "code": 200, "message": "Sucesso", "data": { "name": "Cacongo", "slug": "cacongo", "province": { "name": "Cabinda", "slug": "cabinda", "area": 7283, "founded_at": "1862-02-28" } } }

Buscando os distritos de um município

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

GET /municipalities/{slug}/districts

{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 /municipalities , 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://www.angolaprovinciasapi.oamaralsalgado.ao/api/v2/municipalities/talatona/districts

{ "success": true, "code": 200, "message": "Sucesso", "data": [] }

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 /municipalities/{slug}/communes

{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 /municipalities , 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://www.angolaprovinciasapi.oamaralsalgado.ao/api/v2/municipalities/kilamba-kiaxi/communes

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

Saiba mais sobre como buscar comunas.