nitlab/ibgeapiclient-php

IBGE的REST API客户端

维护者

详细信息

github.com/nibblelab/ibgeapiclient-php

源代码

问题

安装: 50

依赖项: 0

建议者: 0

安全: 0

星星: 0

关注者: 2

分支: 1

开放问题: 0

1.0-stable 2019-09-05 14:47 UTC

Requires

  • php: ^7.1.0
  • lib-curl: *

Requires (Dev)

  • php: ^7.1.0
  • lib-curl: *

Apache-2.0 b4a654b4ce42e596640480aba477da957f6c2d56

  • Johnatas T. Freitas <johnatas.woop@nibblelab.com>

This package is auto-updated.

Last update: 2024-09-19 01:13:02 UTC

README

API规范可以在 https://servicodados.ibge.gov.br/api/docs/localidades?versao=1 找到

摘要

  1. 先决条件
  2. 初始化
  3. 地区
  4. 省（州）
  5. 大区
  6. 小区
  7. 市镇

先决条件

  • PHP >= 7.1.0
  • libcurl
  • composer

安装

使用composer安装

$ composer require nibblelab/ibgeapiclient-php

初始化

包含composer和命名空间。

include './vendor/autoload.php';

use \IBGEApiClient\IBGEApiClient;

地区

所有地区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarRegioes();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按ID获取地区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarRegiaoById('1');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按IDs获取地区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarRegioesByIds(array('1','3'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

省（州）

所有省（州）

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFs(); 
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按ID获取省（州）

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFById('31'); 
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按IDs获取省（州）

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFsByIds(array('31','32')); 
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按地区获取省（州）

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFsByRegiao('3'); 
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按地区获取省（州）

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFsByRegioes(array('2','3')); 
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

大区

所有大区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioes();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按ID获取大区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegiaoById('1101');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按IDs获取大区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByIds(array('1101','1102'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按地区获取大区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByRegiao('1');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按地区获取大区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByRegioes(array('1','2'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按省（州）获取大区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByUF('31');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按省（州）获取大区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByUFs(array('31','27'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

小区

所有小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioes();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按ID获取小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegiaoById('11001');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按IDs获取小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByIds(array('11001','11002'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按地区获取小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByRegiao('1');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按地区获取小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByRegioes(array('1','2'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按省（州）获取小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByUF('31');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按省（州）获取小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByUFs(array('31','27'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按大区获取小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByMesoRegiao('1102');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按大区获取小区

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByMesoRegioes(array('1101','1102'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

市镇

所有市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipios();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按ID获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipioById('3170206');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按IDs获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByIds(array('3170206','5108352'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按地区获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByRegiao('1');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按地区获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByRegioes(array('1','2'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按省（州）获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByUF('31');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按省（州）获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByUFs(array('31','27'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按大区获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByMesoRegiao('1102');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按大区获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByMesoRegioes(array('1101','1102'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按小区获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByMicroRegiao('11001');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

按小区获取市镇

try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByMicroRegioes(array('11001','11002'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

许可证

此项目采用Apache许可证，详细信息请参阅 LICENSE.md