API Integrator
API Integrator Concept
Visual task flow creation
Creating integration scenarios with drag-and-drop interface.
Support for 15+ different connectors
Database, message queue, HTTP, file, and more.
Tasks run in the order they are defined
Each task can use the output of the previous task.
Triggering with scheduler or HTTP
Task flows can run automatically with scheduler or HTTP requests.
Predefined operations in case of error
Operations to be performed in case of error can be defined.
Step-by-step log records and statistics
Execution and log records of each task can be viewed.
Form-based configuration
Creating integration scenarios without writing code with visual interface.
Publishing Task Flows as APIs
Task Flows can be published as REST API or SOAP web service.
API Integrator Features
Task Flow Builder
Visual Designer
- Drag-and-drop interface
- Connector connections
- Flow control (IF-THEN-ELSE)
- Loop and iteration
Data Transformation
- JSON ↔ XML conversion
- Data mapping
- Field transformation
- Data enrichment
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 Connector
Connection to SQL databases (MySQL, PostgreSQL, Oracle, MSSQL, DB2). Running SQL queries and calling stored procedures.
Kafka, RabbitMQ, ActiveMQ
Sending messages to message queues. Message publishing for event-driven architectures.
HTTP/REST, Webhook, Email
REST API calls, sending webhooks, and email sending operations.
FTP/SFTP, Elasticsearch, Script
File transfer, Elasticsearch queries, and running JavaScript/Groovy scripts.
Notification, SNMP, Syslog, Logback
Sending notifications, sending SNMP traps, and sending log records.
Linux Script
Running commands and scripts on remote Linux servers via SSH.
For detailed information about connectors, see the Connector page.
Expose as API
REST API
- Publishing as REST endpoint
- HTTP method support
- Request/Response handling
Scheduled Execution
- Scheduled execution
- Cron expression
- Event-based triggering
Task Flow Manager Usage Areas
Data transfer and exchange between different systems
Data synchronization and transfer between systems.
Automatic email and notification sending
Scheduled or event-driven notifications.
Regular and manageable reporting
Automatic report generation for business workflows.
Scheduling multiple API calls
API calls at specific time intervals or conditions.
Sending messages to systems like Kafka, RabbitMQ
Sending 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
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
Actions are automatically executed when Task Flow fails to complete successfully and ensure awareness of error situations.
Sending notifications with email connector
Notifying external systems by making API Call
Performing operations with database connector
Running Linux script
Running JavaScript/Groovy script
Creating notification
Sending SNMP trap
API Integrator Usage Scenarios
- 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 operation results to message queue (Kafka/RabbitMQ/ActiveMQ Connector)
- Event publishing
- Sending messages for event-driven architectures
- Getting file from FTP (FTP Connector)
- Parsing file content (Script Connector)
- Saving to database (Database Connector)
- Notification after operation (Email Connector)
- Sending email in alarm and monitoring situations (Email Connector)
- Logging (Logback/Syslog Connector)
- Sending notifications (Notification Connector)
- Sending API traffic logs to systems like Elasticsearch, Graylog
- Using Elasticsearch/Graylog Connector
- Central logging and analysis
- Providing protocol conversion like HTTP to MQTT
- Leaving data in message queue with HTTP protocol
- Creating Connector API Proxy
API Integrator Advantages
- Rapid integration without writing code
- Visual designer
- Visual flow diagrams
- Easy debugging
- Reusing Task Flows
- Sharing connectors
- Horizontal scaling
- High throughput
API Integrator Configuration and Access
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
The integrator access address is the URL where the API Integrator service is running. This address is required for API Manager to communicate with API Integrator.
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.
API Integrator is located under the Development menu and is also called Task Flow Manager.