Enterprise API Management

Payload pagination

Problem statement:

A consuming application needs to consume large payloads of data on a pre-defined schedule (for example, daily batches or weekly batches). Although this is typically addressed via traditional batch-based integrations (for example, ETL or just a file transfer), in this case, the information is only accessible through an API.

Solution:

You can create an API that allows payload collections to be retrieved when the plural verb of the resource is accessed. For example, /orders should return the orders collection and /customers the customer collection. However, in order to prevent unbounded responses that could result not just in timeouts but also a degraded performance, limits, and offsets (typically as URL ...