Skip to main content
Version: 4

Architecture and design

The architecture of an app connector (custom and pre-built) framework in Adeptia Connect takes the following into consideration:

  • A connector specification metadata file that contains all the features (for example, Authentication) required to define the characteristics of the app connector. The connector's specification file in Adeptia Connect is an OpenAPI Specification (OAS) v3 definition file which is a language-agnostic, machine-readable document that describes the connector APIs' operations and parameters.
  • OpenAPI extensions to include additional features (for example, Pagination, Batch Processing, etc.) in the specification file. 
  • A runtime engine that reads the connector specification and executes it.
  • A UI to add/upload the connector's specification file for adding the connector to Adeptia Connect.

About connector's specification file​

Adeptia Connect uses OpenAPI Specification (OAS 3.0) based yaml file to define a connector. 

An OAS (previously known as Swagger) based connector YAML file is a configuration file that adheres to the OpenAPI Specification, which is a standardized format for describing RESTful APIs. This YAML file outlines the details required for connecting to and exchanging data with the third-party application. These details include API endpoints, operations, request and response formats, authentication mechanisms, and other relevant information.  

The following key features are the principal constituents of a connector's specification file.   

  • Authentication Mechanism 
  • Trigger  
    • Pagination
    • Incremental Data Strategy  
  • Action 
    • Batch Processing 
    • Field Reference
  • API-based Data Filtering

The following diagram depicts the architecture of an app connector framework.