Integration with external systems

Sterling Intelligent Promising publishes events to Kafka and external applications can subscribe to these events by consuming messages from the corresponding Kafka topic.

Outbound event integration

Table 1. Events and Kafka topics
Event Kafka topic
productAvailability.v2 {topicPrefix}-{environment}-iv-product-availability-v2-container-events
dgAvailabilityChange.v2 {topicPrefix}-{environment}-iv-dg-availability-change-v2-container-events
availableSupplyChange.v2 {topicPrefix}-{environment}-iv-product-available-supply-v2-container-events
supplyChange.v2 {topicPrefix}-{environment}-iv-supply-change-container-events
demandChange {topicPrefix}-{environment}-iv-demand-change-container-events
productAvailabilitySnapshot.v2 {topicPrefix}-{environment}-iv-product-availability-snapshot-v2-container-events
dgAvailabilitySnapshot.v2 {topicPrefix}-{environment}-iv-dg-availability-snapshot-v2-container-events
availableSupplySnapshot.v2 {topicPrefix}-{environment}-iv-product-available-supply-snapshot-container-events
supplySnapshot {topicPrefix}-{environment}-iv-supply-snapshot-container-events.
In order to access the supply snapshot, you must create a publisher for the supplySnapshot event, if one does not already exist.
demandSnapshot {topicPrefix}-{environment}-iv-demand-snapshot-container-events

API integration

IBM® Sterling Intelligent Promising exposes all the APIs as REST APIs and external systems can invoke these APIs for different business use cases. All the incoming APIs to IBM Sterling Intelligent Promising passes through authentication layer and it is important to pass the JWT as a bearer token in all API calls. For more information, see Authenticate APIs.

Event publishing in container environments

Effective 10.0.2409.2 January 2025 release, a publisher is needed to publish the events that you are interested in. The default behavior, which is publishing of all the supported events without any additional configuration is deprecated and will be removed in a future release.

For more information, see Enabling event publishing in containers.