MeusPostosAPI

Conjunto de bibliotecas para facilitar a conexão com a API do projeto Meus Postos - preços atualizados de venda de combustíveis no Brasil

Métodos

Saiba como utilizar nossas API

Abaixo você vai poder conhecer todas as interfaces disponíveis para interagir com os dados do projeto Meus Postos. Não se esqueça que para utilizar a API você deve primeiro autenticar seus pedidos (saiba mais sobre autenticação)

Região Metropolitana

Retorna a lista de todas as regiões metropolitanas brasileiras e as respectivas cidades que fazem parte do projeto MeusPostos

• URL: http://api.meuspostos.com.br/regioes.formato
• Formato: json ou xml
• Parâmetros: nenhum
• Retorno:

Campo	Descrição
data	Nó raiz onde todos as respostas são vinculadas
regioes	Agrupamento de regiões
cd_regiao	Código da região na API MeusPostos
nome	Nome da Região Metropolitana
nome_tela	Nome formatado da Região Metropolitana
cd_cidade_sede	Código da cidade sede da região metropolitana na API
nome_cidade_sede	Nome da cidade sede
cidades	Agrupamento de cidades pertencentes a região metropolitana
cd_cidade	Código da cidade na API MeusPostos
nome	Nome da cidade
nome_tela	Nome formatado da cidade
estado	UF a que pertence a cidade
status	Código HTTP da resposta ao pedido
detail	Detalhes do código de status.
resquest_uri	URI, com parâmetros, que originou a resposta.
created_at	Hora em que foi gerado o pedido
elapsed_time	Tempo para gerar o pedido

Cidades

Retorna a lista de todas as cidades que fazem parte do projeto MeusPostos

• URL: http://api.meuspostos.com.br/cidades.formato
• Formato: json ou xml
• Parâmetros:
  • grupo (opcional): 0 (padrão) para listar todas as cidades, 1 para listar cidades que pertecem a região metropolitana e 2 para listar apenas cidades sede de região metropolitana
  • UF (opcional): silga da Unidade da Federeção. Mostra apenas cidades pertencentes aquela unidade.
• Retorno:

Campo	Descrição
data	Nó raiz onde todos as respostas são vinculadas
cidades	Agrupamento de cidades
cd_cidade	Código da cidade na API MeusPostos
nome	Nome da cidade
nome_tela	Nome formatado da cidade
estado	UF a que pertence a cidade
cd_regiao	Código da região na API MeusPostos. 0 para cidades que nao pertecem a região metropolitana.
nome_regiao	Nome da região metropolitana que a cidade faz parte. Vazio para cidades que não pertecem a região metropoliana.
status	Código HTTP da resposta ao pedido
detail	Detalhes do código de status.
resquest_uri	URI, com parâmetros, que originou a resposta.
created_at	Hora em que foi gerado o pedido
elapsed_time	Tempo para gerar o pedido

Bairros

Retorna a lista dos bairros de uma cidade especifica

• URL: http://api.meuspostos.com.br/bairros.formato
• Formato: json ou xml
• Parâmetros:
  • cidade (obrigatório): Código da cidade que terão os bairros listados.
• Retorno:

Campo	Descrição
data	Nó raiz onde todos as respostas são vinculadas
bairros	Agrupamento de bairros
nome	nome do bairro
status	Código HTTP da resposta ao pedido
detail	Detalhes do código de status.
resquest_uri	URI, com parâmetros, que originou a resposta.
created_at	Hora em que foi gerado o pedido
elapsed_time	Tempo para gerar o pedido

Busca

Efetua uma busca por estabelecimentos no banco de dados do projeto

• URL: http://api.meuspostos.com.br/busca.formato
• Formato: json ou xml
• Parâmetros:
  • chave: palavra-chave para buscar o estabelecimento. Pode ser parte do nome ou parte do endereço conforme registro (não busca por aproximação do endereço. Para isso veja utilize uma ferramenta de geolocalização como o google maps para converter endereço em coordenadas geográficas).Obrigatório na ausência de lat e lon.
  • lat: Valor da latitude de referência para efetuar a busca. Obrigatório na ausência de palavra-chave.
  • lon: Valor da longitude de referência para efetuar a busca. Obrigatório na ausência de palavra-chave.
  • ordem: Opção para ordenação dos resultados: 0 (padrão) - Distância da coordenada de referência, 1 - Preço da Gasolina, 2 - Preço do Alcool, 3 - Preço do Diesel, 4 - Preço do GNV, 5 - Nome do Estabelecimento
  • Cidade: Código da cidade que deseja restringir a pesquisa
  • Bairro: Nome do bairro que deseja restringir a pesquisa
• Retorno:

Campo	Descrição
data	Nó raiz onde todos as respostas são vinculadas
postos	Agrupamento de postos
posto	Código do posto na API MeusPostos.
nome	nome do estabelecimento
endereco	Endereço do estabelecimento.
bairro	Bairro onde o estabelecimento está localizado
dt_pesquisa	Data de quando os dados foram atualizados pela ANP.
bandeira	Nome da bandeira do estabelecimento (ex. Shell, Petrobras, Texaco, Ipiranga)
icone	Endereço no site do projeto para o logo da bandeira do estabelecimento.
gasolina	Preço de venda da gasolina (0.000 quando não tiver informação ou não comercializar).
in_gasolina	Indicador da ANP para comprovação da nota fiscal dacompra de combustível (1 entregou, 0 não entregou).
alcool	Preço de venda do álcool (0.000 quando não tiver informação ou não comercializar).
in_alcool	Indicador da ANP para comprovação da nota fiscal dacompra de combustível (1 entregou, 0 não entregou).
diesel	Preço de venda do diesel (0.000 quando não tiver informação ou não comercializar).
in_diesel	Indicador da ANP para comprovação da nota fiscal dacompra de combustível (1 entregou, 0 não entregou).
gnv	Preço de venda do G.N.V. (0.000 quando não tiver informação ou não comercializar)
in_gnv	Indicador da ANP para comprovação da nota fiscal dacompra de combustível (1 entregou, 0 não entregou).
latitude	Latitude da localização do estabelecimento.
longitude	Longitude da localização do estabelecimento.
distancia	Distância (em linha reta) do ponto de referência.
status	Código HTTP da resposta ao pedido
detail	Detalhes do código de status.
resquest_uri	URI, com parâmetros, que originou a resposta.
created_at	Hora em que foi gerado o pedido
elapsed_time	Tempo para gerar o pedido

Busca

Retorna detalhes sobre um estabelecimento

• URL: http://api.meuspostos.com.br/posto.formato
• Formato: json ou xml
• Parâmetros:
  • posto (obrigatório): Código do posto na API MeusPostos.
• Retorno:

Campo	Descrição
data	Nó raiz onde todos as respostas são vinculadas
postos	Agrupamento de postos
posto	Código do posto na API MeusPostos.
nome	nome do estabelecimento
endereco	Endereço do estabelecimento.
bairro	Bairro onde o estabelecimento está localizado
dt_pesquisa	Data de quando os dados foram atualizados pela ANP.
bandeira	Nome da bandeira do estabelecimento (ex. Shell, Petrobras, Texaco, Ipiranga)
icone	Endereço no site do projeto para o logo da bandeira do estabelecimento.
gasolina	Preço de venda da gasolina (0.000 quando não tiver informação ou não comercializar).
in_gasolina	Indicador da ANP para comprovação da nota fiscal dacompra de combustível (1 entregou, 0 não entregou).
alcool	Preço de venda do álcool (0.000 quando não tiver informação ou não comercializar).
in_alcool	Indicador da ANP para comprovação da nota fiscal dacompra de combustível (1 entregou, 0 não entregou).
diesel	Preço de venda do diesel (0.000 quando não tiver informação ou não comercializar).
in_diesel	Indicador da ANP para comprovação da nota fiscal dacompra de combustível (1 entregou, 0 não entregou).
gnv	Preço de venda do G.N.V. (0.000 quando não tiver informação ou não comercializar)
in_gnv	Indicador da ANP para comprovação da nota fiscal dacompra de combustível (1 entregou, 0 não entregou).
latitude	Latitude da localização do estabelecimento.
longitude	Longitude da localização do estabelecimento.
distancia	Distância (em linha reta) do ponto de referência.
Telefone	Telefone do estabelecimento.
qt_nota1	Quantidade de clientes que derão nota 1 de 5 para o estabelecimento.
qt_nota2	Quantidade de clientes que derão nota 2 de 5 para o estabelecimento.
qt_nota3	Quantidade de clientes que derão nota 3 de 5 para o estabelecimento.
qt_nota4	Quantidade de clientes que derão nota 4 de 5 para o estabelecimento.
qt_nota5	Quantidade de clientes que derão nota 5 de 5 para o estabelecimento.
comentarios	Agrupamento de comentários recebidos.
data	Data em que o comentário foi escrito.
hora	Hora em que o comentário foi escrito.
nome	Nome da pessoa que escreveu o comentário.
avatar	Imagem associada ao autor do comentário.
app	Código do aplicativo que submenteu o comentário para o site (ex.: Orkut, Facebook, etc).
corpo	Texto do comentário.
in_proprietario	Indicador se o comentario é do responsável pelo estabelecimento.
status	Código HTTP da resposta ao pedido
detail	Detalhes do código de status.
resquest_uri	URI, com parâmetros, que originou a resposta.
created_at	Hora em que foi gerado o pedido
elapsed_time	Tempo para gerar o pedido