Configure a Kafka connection

To configure an Apache Kafka connection, follow the steps below:

  1. In the API Connection Manager, add a new connection.

  2. Expand the Edit section of the API Connection Manager.

  3. Specify a Name for your connection.

  4. Select Kafka from the Type dropdown menu.

  5. Enter the name of the Topic you want to connect to.

  6. Specify the Host, i.e. the name or IP address of the Kafka server host.

  7. Enter the Port to listen to.

  8. Specify the GroupId of the consumer group, i.e. the name of the group of consumers that subscribed to this topic.

  9. Enter the number of the Partition that stores the records, i.e. messages. Kafka topics are split into multiple partitions which allows for a distribution of large amounts of data on one or more servers. Each partition has a number, e.g. 0 or 5.

  10. Enable the checkbox next to Peeking to retrieve records from a partition without committing.

    This allows you to read any record, regardless of its position in the partition and without influencing the offset. The offset, i.e. the position of a record, indicates which records have already been consumed and which unread record the API Engine should pull next.

  11. In the Authentication section, enter your Username and Password if required.

  12. Optionally, configure XML and webservice security as described in chapter "Configure security".

Configure a Kafka connection

For detailed information on Kafka topics, see chapter "Run Kafka messages".