Introduction

Introduction

The MadConnect Embedded API enables seamless integration with the MadConnect platform, providing a standardized and efficient way to configure connectors, establish connections, manage accounts, and retrieve reports. Designed for flexibility and scalability, this API allows client applications to embed powerful data connectivity capabilities within their applications while ensuring security and reliability.

The Embedded API supports the following key functionalities:

• Authentication – Secure access using the OAuth client credentials flow, where client applications obtain an access token from MadConnect.

• Account Management - Create and manage accounts under an organization, enabling structured access to resources.

• Connector Management – Configure and authenticate connectors using API key-based or OAuth-based mechanisms.

• Connection Management – Create and manage connections, which serve as scalable data pipelines between source and destination connectors.

• Data Transfers – Initiate and monitor data transfers over active connections.

• Reporting – Retrieve account-level and connection-level reports for insights into usage and data flow.

This document serves as the technical specification for the MadConnect Embedded API and includes:

• API endpoints and their functionalities.

• Request and response formats, including supported HTTP methods and payload structures.

• Authentication mechanisms for secure API access.

• Error handling and response codes for consistent API interactions.

• Retrieve reports at both the account level and connection level to gain insights into usage and data transfers.

The below diagram shows a typical client application interaction using the MadConnect Embedded API.