Generic API integration interface
Alfabet 's generic API integration interface provides a flexible means to integrate with third party components having a RESTful API described via the Open API swagger definition.
The import and export via the generic API integration interface is strictly customer configured. The interface does not provide any methodological pre-configuration. You configure the mapping of data from the third-party component to object classes and object class properties in Alfabet during setup of the interface.
For some third-party components, component specific interfaces are available which provide data import tailored to the specific component. For details about the component specific interfaces, see the respective section in this documentation.
Data import from or export to the third-party component is done in a batch process via the Alfabet data integration framework (ADIF). ADIF jobs can be scheduled on demand to import or export data in regular time intervals like once a day or once every hour.
Alfabet BD GmbH cannot guarantee that the implementation of the generic API integration will succeed with every third-party component having an Open API definition for its RESTful service interface. If data import or export via a generic API fails, please contact Alfabet BD GmbH Support to evaluate whether the problem can be solved by changing the configuration or whether a connection to the third party component cannot be supported. This also helps us to enhance the functionality supported by the generic API integration interface.
The generic API integration interface can be used to integrate with Horizzon® from BizzDesign BV. A preconfigured solution for the integration is available for customers using the predefined IT Transformation Server configuration.
The complete configuration covers
- the setup of the connection to the RESTful services of the third-party component,
- the definition of the structure required to exchange data via the RESTful service endpoints of the third-party component,
- the mapping of data between Alfabet and the third-party component, and
- the import and export mechanisms to trigger import and export via the Alfabet user interface.
The definitions require configuration steps in both Alfabet Expand and the Alfabet user interface. The configuration steps are described in the order of configuration required for defining the interface.