Product Entitlements Operational Sequence #

The Product Entitlements Service supports two distinct modes of interaction: one through the use of RESTful API’s exposed via the Sphera API Portal, and the other through the use of asynchronous messages coming from the SpheraExchange.

REST API’s #

The Product Entitlement Service supports standard RESTful API endpoints supporting complex CRUD operations with extended business logic forming a System of Record (SOR) approach to entitlements at both the company and user levels.

Additional, complex logic to generate logical entitlements data at both the company and user level are accessed via the various entitlement methods (GetCompanyEntitlements, GetUSerEntitlementsm and GetAllEntitlements).

All interactions with the underlying records and data is done through the API layer, including any SpheraExchange-based fire-and-forget operations.

SpheraExchange Interactions #

The Product Entitlements Service also supports inbound integration with the SpheraExchange ProductChange Topic (pub/sub implementation) to process trusted messages from other internal systems where no response is required. These operational endpoints are to address change messages coming from Salesforce, SCN, and other authoritative sources to update the entitlements data store. This topic is locked down for publishing and restricted for internal use only and will NOT be exposed publicly.

Operational Sequence UML #

The operational sequence diagram for typical operations can be either viewed on this page or downloaded in PUML format here.