Premium APIs¶

Introduction¶

Premium APIs tailor-made projections used to handle specific business scenarios. These projections are visible in the API Explorer.

The main objective of premium APIs is to serve as a one-stop solution to each business scenario making the process hassle-free and more efficient. More premium APIs will be added with each newly identified business scenario eliminating the need to call several standard APIs to perform the same.

For a detailed example of a premium API, see Shop Floor Connector

Supporting Resources¶

Technical specifications(OpenAPI v3, v2) and the technical documentation will be provided along with these projections. In addition, the formulation of a comprehensive documentation exclusive to each API is also in progress.

Version Handling¶

Compatibility is handled through proactive warnings to the customers in case migration from one version to another is recommended. The old version of the projection will still be retained along with the new version till the next release to ease the transformation.

Information about any breaking API changes in a release is included with the release documentation at the point of Early Access (EA).

Accessing Premium APIs¶

In IFS Cloud, navigate to Solution Manager > Integration > API Explorer.
Click on the Settings icon and select Column Chooser from the dropdown that appears.
Select Configure columns manually.
Drag and drop API Class from the left panel to the right.
Click OK. Now API Class is added as one of the columns.
In order to filter the Premium APIs, choose API Class as a field from the list of columns and enter premium as the filter value.