Fluent Commerce Logo
Docs
Sign In

Creating a new connector with the Connector SDK

How-to Guide

Author:

Fluent Commerce

Changed on:

1 July 2024

Key Points

  • The Connector SDK generates a blank Maven starting project for your custom integrations.

Steps

Step arrow right iconGenerating a project

With the last package of the Connect SDK starter kit, the zip file will contain the following structure:

No alt provided

To create your first Fluent Connector, run the appropriate installation script for your operational system and follow the prompts. It will ask to provide 2 inputs:

  • Name of the connector
  • Name of the project artifact
No alt provided

Towards the end, it should present a final summary for confirmation before the project is created. Confirm by typing 'y' at the terminal window.

No alt provided

Once the project generation step is complete, a blank canvas maven project will be available in the same folder from where the installation command was executed.

No alt provided

Step arrow right iconConfiguring the project

The next step covers the setup of your IDE and getting localstack up and running. See Dev Environment Setup for more details.

  • To configure your credentials on localstack, use this guide - Credential setup
  • Create the project run configuration on your IDE to start the project. The example below illustrates the following configuration:
    • Spring profiles
    • Environment variables for the SDK internal queues
    • AWS plugin configuration.
No alt provided
Fluent Commerce

Fluent Commerce

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo