Cloud Jasmin DesenvolvimentoGuias
DesenvolvimentoGuias
Guias
Voltar | Lista de artigos

Atualização dos endpoints das integrações

Última alteração a 22/08/2022

Na sequência de uma atualização à plataforma Jasmin, Rose e Invoicing Engine, os endpoints do método GET com o formato {moduleName}/{serviceName}, para obtenção de todos os registos de uma coleção, serão descontinuados a partir de outubro de 2022.

Deste modo, as integrações que utilizem esses endpoints deverão ser adaptadas para passarem a utilizar o formato {moduleName}/{serviceName}/odata. Estes métodos odata possuem melhor performance e permitem realizar, de uma só vez, diversas operações sobre uma coleção, tais como $select, $filter, $count, $top ou $orderby.

Neste sentido, recomendamos que esta verificação e consequente atualização seja realizada até 30 de setembro, sendo possível realizá-la a qualquer momento.

Para saber mais informações sobre como executar queries odata, sugere-se a consulta do artigo de apoio.

Segue um exemplo de com e sem o método odata na obtenção de faturas:

Versão sem odata

Método: GET

Endpoint: (...)/api/XXXXXX/XXXXXX-YYYY/billing/invoices

Resposta:

Versão com odata

Método: GET

Endpoint: (...)/api/XXXXXX/XXXXXX-YYYY/billing/invoices/odata

Resposta:

Diferenças

Como é possível observar no exemplo, o output dos métodos odata possui algumas diferenças:

  • É retornado um objeto com as propriedades itemsnextPageLink e count;
  • A propriedade items é uma coleção de objetos com o(s) resultado(s) obtido(s) no pedido;
  • Por omissão, os resultados obtidos são paginados (máximo de 100 resultados). A propriedade nextPageLink possui o endereço que permite obter o(s) resultado(s) da página seguinte (assume o valor null caso não existam mais páginas).
Adicionar aos favoritos ou partilhar este artigo
Esta página foi útil?
Obrigado pelo seu voto.
login para deixar a sua opinião.
Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!
Artigos Relacionados
Boas práticas de integração Como utilizar OData para obter uma lista de encomendas? Como executar queries OData sobre os dados? Actualización de los endpoints de las integraciones [ES] Códigos de estado das respostas