Connector

Connector is a component in the Apinizer platform that enables connecting to different systems, sending data to these systems, or retrieving data from them. Connectors are used in four main areas: creating integration scenarios in API Integrator Task Flows, providing protocol conversion by creating Connector API Proxies (e.g., HTTP to MQTT), executing actions in Alarm and Monitoring situations, and sending API traffic logs to different systems. Each connector is specialized to communicate with a specific system or protocol. They can be easily used through form-based configuration without writing code.

Connector Features

Diversity

15+ different connector types available

Easy to Use

Form-based configuration, no code writing required

Reusable

Connectors can be used in multiple Task Flows and different areas

Flexible Configuration

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:

Connector Types

Database Connectors

Database Connector

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

Kafka Connector

Apache Kafka integration

Message publishing operations to message queue. Message publishing for event-driven architectures.

RabbitMQ Connector

RabbitMQ integration

Message publishing to message queue and asynchronous messaging operations.

ActiveMQ Connector

Apache ActiveMQ integration

Message publishing to message broker and message queue management.

Communication Connectors

Email Connector

Email sending

Email sending and notification operations with SMTP server configuration.

HTTP/REST Connector

HTTP/REST API calls

Communicating with REST APIs and sending/receiving HTTP requests.

Webhook Connector

Webhook sending

Webhook listening, sending, and performing event-driven operations.

File and Data Connectors

FTP Connector

FTP/SFTP file transfer

File reading, listing, and transfer operations using FTP connections.

Elasticsearch Connector

Elasticsearch queries

Data indexing, search queries, and analytics operations with Elasticsearch connections.

Script Connector

JavaScript/Groovy script execution

Programmatic operations and custom business logic addition using Groovy or JavaScript.

Monitoring and Notification Connectors

Notification Connector

Notification sending

Sending notifications to users when tasks run and notification management.

SNMP Connector

SNMP trap sending

Trap sending with SNMP protocol and network monitoring operations.

Syslog Connector

Syslog message sending

Log message sending with Syslog protocol and centralized logging.

Logback Connector

Log record sending

Log record sending with Logback framework and log management.

System Connectors

Linux Script Connector

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:

In API Integrator Task Flows

Connections to different systems are established in Task Flows and data exchange is provided. Connectors are visually connected to create integration scenarios.

API Proxy Creation

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.

Alarm, Monitoring and Anomaly Detection

Used when executing actions when alarms, monitoring, and anomaly detection situations occur. Operations such as sending notifications and logging in error situations are performed.

API Traffic Logs

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:

Data Synchronization

Retrieving data from source system (Database Connector), transforming data, and sending to target system (HTTP Connector)

Publishing to Message Queue

Sending operation results to message queue (Kafka/RabbitMQ/ActiveMQ Connector) and event publishing

File Processing

Getting file from FTP (FTP Connector), parsing (Script Connector), and saving to database (Database Connector)

Notification and Logging

Sending email in alarm and monitoring situations (Email Connector) and logging (Logback/Syslog Connector)

API Traffic Logging

Sending API traffic logs to systems such as Elasticsearch, Graylog (Elasticsearch/Graylog Connector)

Protocol Conversion

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

Next Steps

Connections

Learn about the connection concept

API Integrator

API Integrator usage

Connectors

Review all connector types

Connector API Proxy

Creating Connector API Proxy

Alarm and Monitoring

Alarm and monitoring usage