Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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

  • Drag-and-drop interface
  • Connector connections
  • Flow control (IF-THEN-ELSE)
  • Loop and iteration
  • JSON ↔ XML conversion
  • Data mapping
  • Field transformation
  • Data enrichment
  • 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.
For detailed information about connectors, see the Connector page.

​
Expose as API

  • Publishing as REST endpoint
  • HTTP method support
  • Request/Response handling
  • 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:
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.

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

  1. Pulling data from source system (Database Connector)
  2. Data transformation (Transformation)
  3. Sending data to target system (HTTP Connector)
  4. Notification in case of error (Email Connector)

Sending Messages to Message Queue

  1. Sending operation results to message queue (Kafka/RabbitMQ/ActiveMQ Connector)
  2. Event publishing
  3. Sending messages for event-driven architectures

File Processing

  1. Getting file from FTP (FTP Connector)
  2. Parsing file content (Script Connector)
  3. Saving to database (Database Connector)
  4. Notification after operation (Email Connector)

Notification and Logging

  1. Sending email in alarm and monitoring situations (Email Connector)
  2. Logging (Logback/Syslog Connector)
  3. Sending notifications (Notification Connector)

API Traffic Logging

  1. Sending API traffic logs to systems like Elasticsearch, Graylog
  2. Using Elasticsearch/Graylog Connector
  3. Central logging and analysis

Protocol Conversion

  1. Providing protocol conversion like HTTP to MQTT
  2. Leaving data in message queue with HTTP protocol
  3. 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 needs to be done to use API Integrator:
  1. Go to Administration tab
  2. Open General Settings page
  3. Find Define Your API Integration Module field
  4. Enter the integrator access address information
  5. Save settings
API Integrator 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.
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 Access
API Integrator is located under the Development menu and is also called Task Flow Manager.

​
Next Steps

Connectors

Learn about connector concept

Task Flow Builder

Task Flow Builder usage

Connections

Learn about connection concept

API Creator

Learn about API Creator component