Datareon Gateway API (not supported)

Datareon API Gateway is a system of the API Management class created on the Datareon platform. The main objective of such systems is to build a centralized API to provide external interaction with a set of applications using a microservice or composite architecture.

In an enterprise information environment, there are usually many systems that operate on various data. Most of these systems provide access to their data through their own mechanisms and services. However, there is often a need to obtain, process, and store data from multiple systems at once. The main approach to solving such problems is to build a centralized API.

The centralized API allows you to:

• Receive information from multiple source systems at once with intermediate processing of results
• Organize intermediate data stores (caches) to speed up results.

The centralized API provides end users with a list of functions related to the transmission, processing or receipt of data or events, taking on the questions of orchestration of this interaction. Thus, internal systems are not subject to changes, there is a clear separation of external API calls from access to internal systems.

Key features

• Implementation of centralized API
• Documentation of the centralized API
• Implementing API Usage Policies

Central API Design

To develop a centralized API, the Datareon Gateway API provides a set of flexible visual design mechanisms. The main mechanisms include:

• Projects. One project implements one API. Multiple projects can be defined on the server at the same time.
• Methods. The mechanism allows you to determine the methods that the centralized API implements. Methods are automatically published to the server and made available to consumers. Each method triggers a call to a business process to receive, process, or transmit data or events.

• Containers. The container mechanism allows you to create data stores that are used as caches at various stages. Creating caches of various levels allows you to significantly increase the reaction rate when calling the appropriate methods.
• Business processes. The Business Process Engine defines approaches to the acquisition, processing and transmission of data and events: protocols for the acquisition and transmission of data, the sequence of their processing, the required responses to external events and the data stores used.

Integration with Internal Systems

Datareon Gateway API implements three integration models:

• Direct interaction with internal systems through the APIs of these systems. In this case, the integration mechanisms of internal systems are called from the business processes defined in the Datareon Gateway API.
• Interoperability with internal systems through the Datareon API Gateway integrated integration API. In this case, internal systems independently call the methods of the built-in integration mechanism Datareon API Gateway.

• Integration via Datareon ESB/. In MQ this case, communication is carried out by transmitting command packets to the Datareon ESB/MQ.

Mixed integration models can be implemented.

Security and Access Model

Access to internal systems through a centralized API itself increases the security of internal systems, since in this case there are no scenarios for direct access to data from outside. In addition, you need to differentiate access to the methods of the centralized API.

There are two types of users in the Datareon Gateway API:

• users calling API methods
• users who configure and maintain the Datareon Gateway API

The user access level can be configured in the context of each Datareon Gateway API object. This allows you to separate user groups by areas of responsibility and restrict access to Datareon Gateway API objects and methods according to permissions.

Diagnostics and Monitoring

The Datareon Gateway API is highly capable of diagnosing and monitoring health. The Diagnostic Center provides complete information about the processes in progress, their status, errors, and expected reactions. The activity logs contain a list of the calls made, the response time to those calls, and the amount of information transmitted. In trace mode, the logs contain additional diagnostic information.

Notification mechanisms are provided to notify system administrators of system errors.

Industrial Deployment Mechanisms

To improve security and fault tolerance, the Datareon Gateway API product implements the project separation model into "Production" and "Development." The differences between these types of projects are as follows:

• «Production». This project type is intended for end users:
  • Direct modification is prohibited
  • No testing and debugging mechanisms
  • Changes are made centrally using special background mechanisms
  • All changes are reverted to the previous version.

• «Development». This project type is designed to develop and modify an existing API:
  • Direct changes allowed
  • Debugging and testing mechanisms present
  • Mechanism for background data acquisition from industrial project
  • No versioning mechanisms
  • It is possible to interact with version control systems.