Documentação da API do Alerta Licitação

Atenção! Todos os endpoints devem ser acessados através do protocolo HTTPS, no endereço https://alertalicitacao.com.br/

Status da API: Em produção.

Ateção! A partir de 01/02/2020 será obrigatória a utilização do parâmetro token, que pode ser passado direto na URL ou nos cabeçalhos (headers).

1) endpoint GET /api/v1/licitacoesAbertas

Método: GET

Retorno em: JSON

Descrição: Consulta as licitações abertas. O sistema considera abertas aquelas licitações com data de abertura maior ou igual à data de hoje (zero horas), com base na data da zona de tempo TimeZone America/Sao_Paulo. As licitações são enviadas no máximo em grupos de 50 e a paginação é controlada através dos parametros pagina e licitacoesPorPagina.

ParametroDescricaoOpc./Obr.Obs
uf Sigla(s) do(s) Estado(s) de interesse Opcional String, Em maiusculo, use uma sigla única para apenas um Estado (exemplo: uf=PR), ou várias siglas separadas por vírgula. (exemplo: uf=PR,SC,RS)
palavra_chave Palavras chave para serem encontradas no objeto da licitação Opcional String. Coloque uma ou mais palavras-chave separadas por vírgula. Coloque palavras-chave que devem aparecer em sequência entre aspas duplas. Coloque um menos na frente de palavras que não devem aparecer na licitação.
pagina Número da página Opcional, padrão=1 Inteiro positivo. Coloque o número da página para consulta. É necessário quando sua consulta passar de 50 licitações. Você pode saber quantas licitações totais foram encontradas na variável totalLicitacoes que é retornada no JSON.
licitacoesPorPagina Número de licitações retoranadas em cada página Opcional, padrão=50. Mínimo=1, máximo=50 Inteiro positivo. Coloque o número de licitações que você quer por página na resposta
token String para autenticação Obrigatório a partir de 01/02/2020 String de 32 caracteres. Apesar de chamarmos de token, na verdade é uma chave (API key) que permite intervalos de consulta menor e acesso a todos os endpoints. Pode ser repassado diretamente através da URL, mas é melhor ser repassado através dos cabeçalhos (HTTP headers). Veja como conseguir seu token aqui
municipio_ibge Codigo do Municipio Opcional. String de 7 caracteres exclusivamente numericoss. Consulte o site do IBGE para saber o código de cada município.

Retorno esperado:Retornará um objeto principal com as propriedades:

ParametroDescricao
totalLicitacoes Inteiro. O número de licitações encontradas
paginas Inteiro. Quantas páginas a consulta retornou, ou quantas são necessárias para ver todas as licitações.
licitacoesPorPagina Inteiro. Quantas licitações devem ser mostradas no m´ximo em cada página. Será igual ao parâmetro licitacoesPorPagina repassado, ou 50, que é o valor padrão.
licitacoesNestaPagina Inteiro. Quantas licitações estão sendo mostradas na página atual. Usualmente será menor na última página.
totalErros Inteiro. O número de erros encontrados nos parâmetros informados. (por exemplo, você definiu pagina=TEXTO). Se for encontrado algum erro, os outros parâmetros não são retornados.
erros Vetor. Um array com todos os erros encontrados. Cada erro é um outro array com as propriedades codigo e descricao
licitacoes Vetor. Um array com as licitações encontradas (em número limitado pela paginação). Cada licitação é um objeto conforme descrito abaixo.

Objeto licitacao: exemplo de objeto retornado através da consulta.

A propriedade municipio_IBGE é o código que o IBGE designou para cada município e pode ser consultado aqui: Página oficial do IBGE.

Atenção: A propriedade abertura_datetime não tem TimeZone definida. O valor dela é o valor que consta no documento de oficial de publicação. Portanto, muitas licitações do Amazonas, Mato Grosso, Rondônia etc. estão no horário de Amazonas, as licitações do Acre geralmente estão no horário do Acre, e assim por diante. A leitura do edital é essencial para saber qual o fuso horário considerado para a licitação.

{
 "id_licitacao":"DM-N-CBD39C0C",
 "titulo":"PREGAO PRESENCIAL 013\/2019",
 "municipio_IBGE":"2602704",
 "uf":"PE",
 "orgao":"Prefeitura de Buenos Aires (PE)",
 "abertura_datetime":"2019-12-30 00:00:00",
 "objeto":"Loca\u00e7\u00e3o de Ve\u00edculos Para Atender as Necessidades de Diversas Secretarias da Prefeitura"
 "link":"https:\/\/alertalicitacao.com.br\/!licitacao\/DM-N-CBD39C0C\",
 "linkExterno":"http:\/\/www.diariomunicipal.com.br\/amupe\/materia\/CBD39C0C",
 "municipio":"Buenos Aires",
 "abertura":"30\/12\/2019",
 "aberturaComHora":"30\/12\/2019 09:00",
 "id_tipo":"8",
 "tipo":"Preg\u00e3o presencial"
}

1.1) Exemplos de utilização:

Exemplo 1: Vamos consultar todas as licitações do Estado de Alagoas:

https://alertalicitacao.com.br/api/v1/licitacoesAbertas/?uf=AL

Talvez você tenha encontrado muitas licitações, em mais de uma página. A consulta acima mostrou apenas as primeiras 50, mas precisamos das próximas 50 (licitações 51 a 100), então vamos fazer a seguinte consulta:

https://alertalicitacao.com.br/api/v1/licitacoesAbertas/?uf=AL&pagina=2

Talvez você não precise de todas as Licitações de Alagoas. Vamos pegar só aquelas que contenham "Engenharia"

https://alertalicitacao.com.br/api/v1/licitacoesAbertas/?uf=AL&palavra_chave=engenharia

Legal, agora vamos ver as licitações de engenharia de toda a região Nordeste (informar as UF separado por vírgula)

https://alertalicitacao.com.br/api/v1/licitacoesAbertas/?uf=MA,PI,CE,RN,PB,PE,AL,SE,BA&palavra_chave=engenharia

Legal, agora vamos ver as licitações que contém INFORMÁTICA, mas que não contém SUPORTE . O parâmetro palavra_chave abaixo é o URL encoded para: informática, -suporte

https://alertalicitacao.com.br/api/v1/licitacoesAbertas/?palavra_chave=inform%C3%A1tica%2C+-suporte

Se você precisa de uma palavra composta, ou de duas palavras que obrigatoriamente tem de aparecer em ordem, coloque entre aspas duplas, por exemplo: "locação de veículos". Assim o sistema não pega outras locações, como de imóveis, por exemplo, ou venda de veículos.

https://alertalicitacao.com.br/api/v1/licitacoesAbertas/?palavra_chave=%22loca%C3%A7%C3%A3o+de+ve%C3%ADculos%22

Se você precisa das licitações de apenas um município, pode passar o parâmetro municipio_ibge. Exemplo: Licitações da cidade de São Paulo (SP).

https://alertalicitacao.com.br/api/v1/licitacoesAbertas/?municipio_ibge=3550308

2) endpoint GET /api/v1/licitacoesAbertasRSS

Método: GET

Retorno em: XML+RSS (UTF-8)

Descrição: Consulta as licitações abertas. O sistema considera abertas aquelas licitações com data de abertura maior ou igual à data de hoje (zero horas), com base na data da zona de tempo TimeZone America/Sao_Paulo. As licitações são enviadas no máximo em grupos de 50 e a paginação é controlada através dos parametros pagina e licitacoesPorPagina.

Este endpoint utiliza os mesmo parâmetros que o licitacoesAbertas, logo acima.. A única diferença é o retorno em formato RSS (para integração com leitores de feeds RSS)

Exemplo 1: Vamos consultar todas as licitações do Estado de Alagoas:

https://alertalicitacao.com.br/api/v1/licitacoesAbertasRSS/?uf=AL