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/

Atenção! Esta API está em testes, portanto ainda nao está estável para produção. Ela terá continuidade no desenvolvimento, pois supre uma demanda do mercado, no entanto não garantimos 100% de uptime e entrega devido ao período de testes. Por favor informe qualquer erro encontrado para melhorar o sistema.

Atenção: Coloque um temporizador ao fazer varreduras muito grandes (por exemplo, faça uma consulta a cada dois segundos), pois você poderá ser bloqueado

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

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 estão sendo mostradas em cada página. Será igual ao parâmetro licitacoesPorPagina repassado, ou 50, que é o valor padrão.
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.

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