Actualización de los endpoints de las integraciones [ES]

En la secuencia de una actualización a la plataforma Jasmin, Rose e Invoicing Engine, los endpoints del método GET con el formato {moduleName}/{serviceName}, para obtener todos los registros de una colección, serán descontinuados a partir de octubre de 2022.

De este modo, en las integraciones que usan estos endpoints deberán ser adaptadas para usar el formato {moduleName}/{serviceName}/odata. Estos métodos odata permiten obtener mejores índices de desempeño, así como realizar, de una sola vez, diversas operaciones sobre una colección, como $select, $filter, $count, $top o $orderby.

En este sentido, recomendamos que esta comprobación y la consecuente actualización sean realizadas hasta el 30 de septiembre y esta puede ser realizada en cualquier momento.

Para más informaciones sobre como ejecutar queries odata sobre los dados de Jasmin, se sugiere consultar el artículo de apoyo.

A continuación se presenta un ejemplo con y sin el método odata al obtener facturas:

Versión sin odata

Método: GET

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

Respuesta:

Versión con odata

Método: GET

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

Respuesta:

Diferencias

Como es posible observar en el ejemplo, el output de los métodos odata tiene algunas diferencias:

• Se devuelve un objeto con las propiedades items, nextPageLink y count;
• La propiedad items es una colección de objetos con los resultados obtenidos en la solicitud;
• Por defecto, los resultados obtenidos son paginados (máximo de 100 resultados). La propiedad nextPageLink tiene la dirección que permite obtener los resultados de la página siguiente (asume el valor null caso no existan más páginas).