Integrating capacity data from external systems by using APIs

You can integrate capacity data from an external capacity management system to Sterling Intelligent Promising by using APIs.

Before you begin

  • Familiarize yourself with the Capacity concept in Sterling Intelligent Promising. For more information, see Capacity service.
  • Before you start, check whether a time zone conversion of the availability timestamps is needed for propagating accurate capacity availability data in Sterling Intelligent Promising.

About this task

The integration of capacity data involves the following three steps:
  1. Capturing capacity changes in the Order Management System by using events.
  2. Updating capacity in Sterling Intelligent Promising with Sterling Intelligent Promising APIs.
  3. Reserving capacity in the Order Management System while taking reservations in Sterling Intelligent Promising.

Procedure

  1. To integrate the data, trigger the updates in Sterling Intelligent Promising by mapping the Order Management System events to Sterling Intelligent Promising APIs. It is important to verify that the system matches the format that is required by the Sterling Intelligent Promising capacity APIs. For more information about capacity APIs, see Capacity.
    • Endpoint: 
      GET/PUT/promising/{tenantId}/v2/nodes/{nodeId}/capacity/{capacityUom}/{categoryId}
    • Method: Implement PUT requests to update Sterling Intelligent Promising capacity that is based on the order management events.
    • Configuration: Collect the necessary node-specific parameters, such as tenantId, nodeId, capacityUom, categoryId to propagate data to Sterling Intelligent Promising.
  2. Transform the capacity data at the source system to conform to the Capacity APIs and update capacity in Sterling Intelligent Promising. For more information, see Calculate capacity availability.
  3. Test and validate the data integration to help ensure that it is accurate for your system.
    • Run staging tests in a staging environment to confirm end-to-end data flows from the Order Management System to Sterling Intelligent Promising.
    • Run peak load testing to verify that the data in Sterling Intelligent Promising accurately reflects the updates in the order management capacity. This testing helps prepare for scalability at peak times and during high-usage scenarios.