API Integrator Concept
Task Flow Builder
Visual task flow creationCreating integration scenarios with drag-and-drop interface.
Connectors
Support for 15+ different connectorsDatabase, message queue, HTTP, file, and more.
Sequential Tasks
Tasks run in the order they are definedEach task can use the output of the previous task.
Automatic Triggering
Triggering with scheduler or HTTPTask flows can run automatically with scheduler or HTTP requests.
Error Management
Predefined operations in case of errorOperations to be performed in case of error can be defined.
Monitoring and Logging
Step-by-step log records and statisticsExecution and log records of each task can be viewed.
No Code Writing
Form-based configurationCreating integration scenarios without writing code with visual interface.
Expose as API
Publishing Task Flows as APIsTask Flows can be published as REST API or SOAP web service.
API Integrator Features
Task Flow Builder
Visual Designer
Visual Designer
- Drag-and-drop interface
- Connector connections
- Flow control (IF-THEN-ELSE)
- Loop and iteration
Data Transformation
Data Transformation
- JSON ↔ XML conversion
- Data mapping
- Field transformation
- Data enrichment
Error Handling
Error Handling
- Try-catch blocks
- Error handling strategies
- Retry mechanism
- Fallback strategies
Connectors
API Integrator provides support for 15+ different connectors. Connectors are explained in detail on the connector.mdx page:Database Connectors
Database ConnectorConnection to SQL databases (MySQL, PostgreSQL, Oracle, MSSQL, DB2). Running SQL queries and calling stored procedures.
Message Queue Connectors
Kafka, RabbitMQ, ActiveMQSending messages to message queues. Message publishing for event-driven architectures.
Communication Connectors
HTTP/REST, Webhook, EmailREST API calls, sending webhooks, and email sending operations.
File and Data Connectors
FTP/SFTP, Elasticsearch, ScriptFile transfer, Elasticsearch queries, and running JavaScript/Groovy scripts.
Monitoring and Notification Connectors
Notification, SNMP, Syslog, LogbackSending notifications, sending SNMP traps, and sending log records.
System Connectors
Linux ScriptRunning commands and scripts on remote Linux servers via SSH.
Expose as API
REST API
REST API
- Publishing as REST endpoint
- HTTP method support
- Request/Response handling
Scheduled Execution
Scheduled Execution
- Scheduled execution
- Cron expression
- Event-based triggering
Task Flow Manager Usage Areas
Data Transfer
Data transfer and exchange between different systemsData synchronization and transfer between systems.
Automatic Notifications
Automatic email and notification sendingScheduled or event-driven notifications.
Reporting
Regular and manageable reportingAutomatic report generation for business workflows.
API Calls
Scheduling multiple API callsAPI calls at specific time intervals or conditions.
Message Queue
Sending messages to systems like Kafka, RabbitMQSending data to message queue systems.
Task Flow Manager Task Types
If the flow fails to complete successfully, you can be notified by defining an action from any of the following task types:Action Task Types
Action Task Types
Actions that can be executed when Task Flow fails to complete successfully:
- Send Email: Sending notifications with email connector
- API Call: Notifying external systems by making API Call
- Database Operation: Performing operations with database connector
- Linux Script: Running Linux script
- Script: Running JavaScript/Groovy script
- Notification: Creating notification
- SNMP: Sending SNMP trap
Send Email
Sending notifications with email connector
API Call
Notifying external systems by making API Call
Database Operation
Performing operations with database connector
Linux Script
Running Linux script
Script
Running JavaScript/Groovy script
Notification
Creating notification
SNMP
Sending SNMP trap
API Integrator Usage Scenarios
Data Synchronization
- Pulling data from source system (Database Connector)
- Data transformation (Transformation)
- Sending data to target system (HTTP Connector)
- Notification in case of error (Email Connector)
Sending Messages to Message Queue
- Sending operation results to message queue (Kafka/RabbitMQ/ActiveMQ Connector)
- Event publishing
- Sending messages for event-driven architectures
File Processing
- Getting file from FTP (FTP Connector)
- Parsing file content (Script Connector)
- Saving to database (Database Connector)
- Notification after operation (Email Connector)
Notification and Logging
- Sending email in alarm and monitoring situations (Email Connector)
- Logging (Logback/Syslog Connector)
- Sending notifications (Notification Connector)
API Traffic Logging
- Sending API traffic logs to systems like Elasticsearch, Graylog
- Using Elasticsearch/Graylog Connector
- Central logging and analysis
Protocol Conversion
- Providing protocol conversion like HTTP to MQTT
- Leaving data in message queue with HTTP protocol
- Creating Connector API Proxy
API Integrator Advantages
Rapid Development
- Rapid integration without writing code
- Visual designer
Easy Maintenance
- Visual flow diagrams
- Easy debugging
Reusability
- Reusing Task Flows
- Sharing connectors
Scalability
- Horizontal scaling
- High throughput
API Integrator Configuration and Access
Configuration Steps
Configuration Steps
Configuration needs to be done to use API Integrator:
- Go to Administration tab
- Open General Settings page
- Find Define Your API Integration Module field
- Enter the integrator access address information
- Save settings
Access
Access
Accessing Task Flow Manager:You can access API Integrator (Task Flow Manager) under the Development tab in the navigation bar on the left side of the screen.