Since the previous release, there have been updates to both the platform API and its documentation.
In this document:
The special HTTP header X-Calculate-Total-Count=false
used to turn off the calculation of all orders in the platform
when processing a request for a collection of orders is replaced with APS-Skip-Content-Range.
The latter is a header unified for all collection requests regardless of the resource type.
The PaymentManagement APS type is extended with a new custom operation update
that
enables external systems to request for payment release and payment void billing operations, which were previously
available only in the user panels.
The improved payments
operation is extended with a set of RQL-style operators and functions that allow external
systems to narrow down the list of payments they want to get from the payment manager.
For more details about payment operations, refer to Typical Scenario, Scopes of GET Requests, and various Examples.
The OrderManagementApplication APS type is extended with a new structure
providerCosts
that is applicable to sales orders. This enables the provider to record special fees they pay to
service vendors for particular services.
This API extension helps the provider consolidate their balance when they pay special fees for the services they resell.
For more details, refer to the respective example and limitations in OrderManagementApplication.
The identity provider (IDP) is a microservice that extends the platform capabilities to interact with various authentication services using the OAuth 2 framework with the OpenID Connect extension. External systems functioning as API clients on the APS bus can request a platform user’s authorization from the IDP. The authorization is granted by a security token generated by the IDP and used by the API client to authorize its requests on the APS bus.
For more details, refer to Authorization through IDP.
A subscription can have a payment method attached to it. This enables a subscriber to specify a preferred payment method to pay orders related to that subscription.
For more details about this process, refer to the respective examples and limitations in BSSSubscription.
In addition to the documentation updates related to the API new features described in the previous sections, the existing API documents were also improved as reported in the following sections.
The Limitations section is added to the
OnScreenNotificationManager document. This section explains
the effect of the addressee type choice (accountId
or userId
) on the list of notification recipients.
bss-accounts
¶The bss-accounts
alias is published in the Collections table. This alias refers to the
BssAccountInformation APS type.
notificationEmail
Property¶The explanation of the notificationEmail
property is added to the document describing the
Contact abstract APS type.
The new Limitations section specifies the payload size limit in API requests.
In Reporting and Data Export and other documents, the “Rated Data Export” service is renamed to “Reporting and Data Export”, retaining the acronym “RDE”.