Connector
Connector Features
15+ different connector types available
Form-based configuration, no code writing required
Connectors can be used in multiple Task Flows and different areas
Connectors can be configured to suit different scenarios
Connector Usage Flow
The following diagram shows how connectors are used in API Proxies and Task Flows:
sequenceDiagram
participant Client as 👤 Client
participant Gateway as 🚪 API Gateway
participant Proxy as 🔀 API Proxy/Task Flow
participant Connector as 🔌 Connector
participant Connection as 🔗 Connection
participant ExternalSystem as 🖥️ External System
Client->>Gateway: HTTP Request
Note over Gateway: Request Reached Gateway
Gateway->>Proxy: Route Request to API Proxy/Task Flow
Note over Proxy: Processing Started
Proxy->>Connector: Connector Called<br/>(Form-Based Configuration)
Note over Connector: Connector Types:<br/>Database, Kafka, RabbitMQ,<br/>Email, HTTP, FTP,<br/>Elasticsearch, Script, etc.
Connector->>Connection: Connection Usage<br/>(Centralized Configuration)
Note over Connection: Connection Information<br/>(Host, Port, Credentials)
Connection->>ExternalSystem: Connection Established<br/>to External System (SSL/TLS)
Note over ExternalSystem: External System Types:<br/>Database (MySQL, PostgreSQL, MongoDB)<br/>Message Queue (Kafka, RabbitMQ, ActiveMQ)<br/>Email (SMTP)<br/>File (FTP/SFTP)<br/>Search (Elasticsearch)<br/>HTTP/REST API
alt Data Reading Scenario
ExternalSystem->>Connection: Data Returns
Connection->>Connector: Connection Result
Connector->>Connector: Data Transformation<br/>(JSON ↔ XML, Mapping)
Connector->>Proxy: Processed Data
else Data Writing Scenario
Connector->>Connection: Data Sent
Connection->>ExternalSystem: Data Transmitted
ExternalSystem->>Connection: Operation Result
Connection->>Connector: Success/Error Status
Connector->>Proxy: Operation Result
else Protocol Conversion Scenario<br/>(Connector API Proxy)
Connector->>Connection: HTTP → MQTT/Kafka<br/>Protocol Conversion
Connection->>ExternalSystem: Converted Message
ExternalSystem->>Connection: Confirmation
Connection->>Connector: Conversion Completed
Connector->>Proxy: Success Status
end
Proxy->>Gateway: Processed Response
Gateway->>Client: HTTP Response
Note over Client,Gateway: Process Completed
Note over Connector,ExternalSystem: Connectors Are Reusable<br/>and Can Be Used<br/>in Multiple Scenarios
Connector Types
Database Connectors
Connection to SQL databases (MySQL, PostgreSQL, Oracle, MSSQL, DB2)
SQL queries can be executed and database operations can be performed using database connections.
Message Queue Connectors
Apache Kafka integration
Message publishing operations to message queue. Message publishing for event-driven architectures.
RabbitMQ integration
Message publishing to message queue and asynchronous messaging operations.
Apache ActiveMQ integration
Message publishing to message broker and message queue management.
Communication Connectors
Email sending
Email sending and notification operations with SMTP server configuration.
HTTP/REST API calls
Communicating with REST APIs and sending/receiving HTTP requests.
Webhook sending
Webhook listening, sending, and performing event-driven operations.
File and Data Connectors
FTP/SFTP file transfer
File reading, listing, and transfer operations using FTP connections.
Elasticsearch queries
Data indexing, search queries, and analytics operations with Elasticsearch connections.
JavaScript/Groovy script execution
Programmatic operations and custom business logic addition using Groovy or JavaScript.
Monitoring and Notification Connectors
Notification sending
Sending notifications to users when tasks run and notification management.
SNMP trap sending
Trap sending with SNMP protocol and network monitoring operations.
Syslog message sending
Log message sending with Syslog protocol and centralized logging.
Log record sending
Log record sending with Logback framework and log management.
System Connectors
Linux command execution
Command and script execution on remote Linux servers via SSH.
Elasticsearch Connector is particularly important. Querying and visualizing API Traffic analytically in the Apinizer Management Console is only possible by adding the Elasticsearch Connector to the relevant environment.
Connector Usage Areas
Connectors are used in four main areas in the Apinizer platform:
Connections to different systems are established in Task Flows and data exchange is provided. Connectors are visually connected to create integration scenarios.
API Proxies can be created with connectors. This enables protocol conversion such as HTTP to MQTT. For example, data can be placed in a message queue via HTTP protocol.
Used when executing actions when alarms, monitoring, and anomaly detection situations occur. Operations such as sending notifications and logging in error situations are performed.
Used to send API traffic logs to other systems. Logs are sent to logging systems such as Elasticsearch, Graylog, Syslog.
Usage Scenarios
Connectors can be used in various integration scenarios:
Retrieving data from source system (Database Connector), transforming data, and sending to target system (HTTP Connector)
Sending operation results to message queue (Kafka/RabbitMQ/ActiveMQ Connector) and event publishing
Getting file from FTP (FTP Connector), parsing (Script Connector), and saving to database (Database Connector)
Sending email in alarm and monitoring situations (Email Connector) and logging (Logback/Syslog Connector)
Sending API traffic logs to systems such as Elasticsearch, Graylog (Elasticsearch/Graylog Connector)
Providing protocol conversion such as HTTP to MQTT. Placing data in message queue via HTTP protocol (Connector API Proxy)
Connector Configuration
When configuring connectors, the following information is defined:
Connection Selection
The connection (Connection) to be used by the connector is selected. The connection must have been defined previously.
Parameters
Different parameters are defined according to connector type:
- SQL queries for database connectors
- URL, method, headers for HTTP connectors
- Recipient, subject, content for email connectors
Data Transformation
Some connectors can perform data transformation:
- JSON ↔ XML conversion
- Data mapping and transformation
- Format conversions
Error Management
Connectors can manage error situations:
- Retry mechanism
- Error handling
- Fallback strategies