A pesquisa de registros é realizando com o método HTTP GET
.
Objetivando facilitar e otimizar as pesquisas de registros no ERP, a API ConectorGate possui alguns recursos avançados de API HTTP REST como o recurso de paginação e de consulta incremental.
A API ConectorGate, no momento não conta com outros recursos avançados de API HTTP REST como: expand, crossjoin, etc.
Paginação
O recurso de paginação permite pesquisar um volume grande de registros em objetos de negócio. Afim de reduzir o tamanho do response, os registros são divididos em páginas.
Para obter todos os registros de uma pesquisa com um volume grande de registros recomenda-se:
- Realizar GET sem usar pageNum
- Verificar no response o valor de pageTotal
- Realizar laço de GETs, variando de pageNum=2 até pageTotal
Consulta Incremental
O recurso de consulta incremental permite obter apenas os registros que foram criados e/ou atualizados após determinada data/hora. Com isto é possível pesquisar apenas registros recentes, modificados após a última pesquisa realizada.
Para cadastros base, que necessitam de carga de dados no golive da integração, recomenda-se que:
- Seja realizada uma única vez a carga full, sem utilizar updatedAt (e usando de paginação caso necessário). Observação: dar preferência por intervalos menores de datas e múltiplas consultas na carga de dados, do que uma única consulta com um intervalo muito grande.
- Sejam realizadas periodicamente cargas incrementais, utilizando o campo “updatedAt” preenchido com a data/hora da última pesquisa realizada.