É possível consultar as cidades (ID, nome e UF) através de consulta via API.

Temos abaixo alguns exemplos de REQUESTs:

  • Lista de cidades filtradas por um nome (ou parte dele)
curl -X GET -H "Accept: application/json" "http://api.memed.com.br/v1/cidades?filter[q]=Campinas"
  • Lista de cidades filtradas pela UF
curl -X GET -H "Accept: application/json" "http://api.memed.com.br/v1/cidades?filter[uf]=SP"
  • Lista de cidades com filtros combinados
curl -X GET -H "Accept: application/json" "http://api.memed.com.br/v1/cidades?filter[uf]=SP&filter[q]=camp&page[limit]=200"
  • Lista de todas as cidades
curl -X GET -H "Accept: application/json" "http://api.memed.com.br/v1/cidades?page[limit]=6000"


Obs
.: Por padrão, o resultado é limitado a 100 registros. Portanto, caso necessite de uma quantidade maior, basta usar a query string page[limit] (quantidade de registros).

  • Lista de cidades usando paginação
curl -X GET -H "Accept: application/json" "http://api.memed.com.br/v1/cidades?filter[uf]=SP&page[limit]=5&page[offset]=5"

Obs.: Caso precise fazer a consulta paginada, combine as query strings page[limit]  e page[offset] (a partir de).

O retorno das consultas seguirá a estrutura a seguir

{
    "data": [
        {
            "type": "cidades",
            "attributes": {
                "nome": "Campinas",
                "uf": "SP"
            },
            "links": {
                "self": "http://api.memed.com.br/v1/cidades/4757"
            },
            "id": 4757
        }
    ],
    "links": {
        "self": "http://api.memed.com.br/cidades"
    },
    "meta": {
        "total": 1,
        "limit": 100
    }
}


Estamos à disposição para eventuais dúvidas no chat! 


Encontrou sua resposta?