A quem se destina?
A todos os programadores e/ou webmasters que queiram
integrar os ajustes no seu site/aplicação
Em que formato são disponibilizadas as operações?
Actualmente em xml/json
É livre?
Sim. A única restrição é no número de chamadas que cada
chave (API Key) pode fazer ao serviço. Estamos a limitar este número a
100.000/dia
Que operações são disponibilizadas?
Actualmente disponibilizamos as seguintes operações
(deve acrescentar "api/A_SUA_CHAVE" no final de cada url):
- Últimos Ajustes - http://ajustesajustados.com/services/ultimos/
- Ajustes Mais caros - http://ajustesajustados.com/services/top/
- Entidades Totalitárias -
http://ajustesajustados.com/services/totalitarias/
- Ajustes Interessantes -
http://ajustesajustados.com/services/interessantes/
- Detalhe Ajuste -
http://ajustesajustados.com/services/detalhe/id/ID_DETALHE/
- Pesquisa -
http://ajustesajustados.com/services/pesquisa/termo/TERMO_A_PESQUISAR
- Para pesquisar nas entidades (adjudicantes ou adjudicatárias) adicione o parâmetro /tipo/entidade. Exemplo: http://ajustesajustados.com/services/pesquisa/tipo/entidade/termo/barcelos/
- termo - O termo a pesquisar url encoded. Exemplo:
http://ajustesajustados.com/services/pesquisa/api/A_MINHA_CHAVE/termo/barcelos
ou
http://ajustesajustados.com/services/pesquisa/api/A_MINHA_CHAVE/termo/%2besposende%2bambiente
(Os operadores +,-,~,(), estão disponíveis nesta pesquisa (full-text
MySQL) )
- Listagem Adjudicantes -
http://ajustesajustados.com/services/adjudicantes/
- Listagem Adjudicatárias -
http://ajustesajustados.com/services/adjudicatarias/
- Detalhe Entidade -
http://ajustesajustados.com/services/entidade/id/ID_ENTIDADE
- Detalhes mais comentados -
http://ajustesajustados.com/services/comentarios/
Quais os parâmetros que cada chamada pode ter?
Além do url base
(http://ajustesajustados.com/services/[operacao]/api/A_MINHA_CHAVE/)
existe um número de parâmetros que pode ser passado e que são comuns às
operações:
- start - Indica em que posição deve começar a listagem. Omissão é 0
(zero)
- perPage - O número de registos a mostrar. Número entre 1 e 100. Por
omissão é 10
- order - A ordenação dos resultados. Todas as colunas que vem no
serviço podem ser ordenadas. Basta adicionar o parâmetro order seguido
de sublinhado e a ordem pretendida (desc|asc). Exemplo:
http://ajustesajustados.com/services/adjudicatarias/api/A_MINHA_CHAVE/order/preco_desc
(preco é o nome do campo. Os campos disponíveis são listados nos
resultados)
- export - O formato em que devem ser fornecidos os resultados
(json|xml). Por omissão é xml
Onde está a minha CHAVE API?
A sua chave encontra-se no seu painel de controlo nas
definições de conta