Tempo aproximado para leitura: 00:02:00 min
Dúvida
Realizando uma consulta com campos detalhados usando o Integration-Filter no Postman
Ambiente
Cross Segmentos - TOTVS CRM Gestão de Clientes - API de Integração - Todas as versões
Solução
Para realizar a requisição na API de integração com campos detalhados na ferramenta postman, é necessário preencher todos os campos que são obrigatórios. Mostraremos como funciona esse processo logo abaixo.
Importante!
O processo completo de integração via API está descrito no artigo Utilização da API de Integração na prática.
Aqui, demonstraremos somente a parte dos campos obrigatórios da API.
1. Efetue uma requisição usando o método POST efetuando o login conforme artigo de exemplo informado acima.
2. Após efetuado o login estaremos usando de exemplo a API de CUSTOMER.
3. Geralmente é usado no campo Integration-Filter o ID do cliente, para buscar apenas este registro, mas podemos usar outros campos.
3.1 Para realizar esta busca é necessário que obtenha conhecimento da forma correta, a realizando da seguinte forma.
3.2 Conforme imagem acima é necessário que seja filtrado usando as seguintes opções:
"->" Apenas este sinal significa é, após ele é usado filtros como isNnull que significa É não nulo. Ou isNull que significa é nulo.
"-> eq ->" Este sinal tem o significado de igual do inglês Equal, após ele você pode usar o filtro desejado, como uma informação fixa, conforme exemplo acima, Acrônimo do tipo de endereço = Principal.
"->gt ->" Este sinal é utilizado para filtros de horários como sua ultima data de atualização ou data de criação, dependendo da circunstância a ser utilizado.
4. Após entendermos como funcionam os filtros, podemos ver na prática como os dados são retornados. Realizei a inserção do filtro:
{customerPersonType->isNnull}{addresses->isNnull}{addresses.cityId->isNnull}{addresses.active->eq->true}{lastUpdatedAt->gt->2023-07-01T11:47:06.247Z}.
4.1 Conforme imagem acima existe um parâmetro chamado count é um contador de registros, com isso obtivemos nesta consulta um total de 5 registros com base nos filtros informados.
Artigos relacionados:
0 Comentários