- Entendendo os Filtros
- Parâmetros Disponíveis (Exemplo)
- Exemplos Práticos no Postman
- Perguntas Frequentes (FAQ)
Nas APIs do Checklist Fácil, você pode utilizar filtros para auxiliar e otimizar as consultas realizadas. Para cada recurso ou rota disponível na API, a documentação lista os filtros aceitos e seus respectivos tipos (o formato em que devem ser utilizados).
Entendendo os Filtros
Como exemplo didático, vamos considerar a listagem de unidades. Ao consultar a documentação, podemos identificar quais parâmetros essa listagem aceita.
Parâmetros Disponíveis (Exemplo)
Com base na imagem acima, identificamos os seguintes parâmetros para filtrar unidades:
- name: Filtra pelo nome da unidade, utilizando o conteúdo exato informado no campo.
- unitTypeId: Filtra informando o ID (identificador) do tipo de unidade.
- active: Filtra pelo status do registro (ex: buscar apenas unidades desativadas).
- page: Define qual página de resultados está sendo requisitada.
- limit: Define o número de registros a serem retornados na consulta.
Sobre o parâmetro limit: Ele possui um limite máximo de registros. A API Integration permite retornar no máximo 100 registros por página. Você pode diminuir esse número, mas não aumentá-lo.
Sempre que você realizar um filtro na API, ele será informado como uma Query String (uma parte da requisição HTTP) para mais detalhes pode ser consultado https://en.wikipedia.org/wiki/Query_string.
Exemplos Práticos no Postman
No Postman, a utilização de Query String é feita na aba Params (Query params) da requisição.
1. Consultando apenas unidades ativas
2. Consultando a segunda página de unidades ativas
Perguntas Frequentes (FAQ)
1. Posso aumentar o limite de registros para mais de 100?
Não. O limite máximo de registros por página na API Integration é de 100 itens. Caso precise de mais dados, será necessário utilizar o parâmetro page para navegar entre as páginas.
2. Onde encontro os filtros de outras rotas?
Cada rota possui sua própria documentação específica dentro do manual da API, onde são listados os filtros suportados e o tipo de dado esperado (texto, número, booleano, etc.).
❓Tem dúvidas? Entre em contato com nosso time de suporte.