n8n-nodes-connector-engine

Universal Connector Engine node for n8n. Connects to your ERP Integration Execution API and runs connector capabilities (resources and operations) with schema-driven input fields.

Requirements

• Node.js 18+ (for building the package)
• n8n instance (cloud or self-hosted)
• Connector Engine API (base URL + API key from your ERP Integration app)

Build (required before install from path)

From the package directory:

npm install
npm run build

This produces the dist/ folder that n8n loads.

Install in n8n

Option A: From zip (no build, ready to install)

Use the pre-built zip so you don’t need Node 18 or to run npm run build.

1. Get n8n-nodes-connector-engine.zip (from the repo or run npm run zip in the package folder to create it).
2. Unzip it into a folder, e.g.:

   mkdir -p n8n-nodes-connector-engine
   cd n8n-nodes-connector-engine
   unzip /path/to/n8n-nodes-connector-engine.zip

   You should see package.json, README.md, and dist/ in that folder.
3. On the machine where n8n runs, install from that folder:

   mkdir -p ~/.n8n/nodes
   cd ~/.n8n/nodes
   npm install /path/to/n8n-nodes-connector-engine

4. Restart n8n. The Connector Engine node and Connector Engine API credential will be available.

Option B: From n8n UI (if published to npm)

1. In n8n: Settings → Community nodes → Install.
2. Enter: n8n-nodes-connector-engine.
3. Install and restart if prompted.

Option C: Install from local path (self-hosted)

1. Build the package (see above) so dist/ exists.
2. On the machine where n8n runs, install the package into n8n’s nodes directory:

mkdir -p ~/.n8n/nodes
cd ~/.n8n/nodes
npm install /path/to/n8n-nodes-connector-engine

3. Restart n8n.

Option D: Docker / queue mode

1. Build the package locally (Node 18+) so dist/ exists.
2. Copy the built package (or the repo) into the container and install:

docker exec -it n8n sh
mkdir -p ~/.n8n/nodes
cd ~/.n8n/nodes
npm install /path/to/n8n-nodes-connector-engine

3. Restart the n8n container.

Usage

1. Add a Connector Engine node to your workflow.
2. Create a Connector Engine API credential:
   • Base URL: your Execution API base URL (e.g. https://your-app.com/api or http://localhost/api).
   • API Key: an API key from your ERP Integration app (API Keys page).
3. In the node, choose Connector → Resource → Operation (loaded from your API).
4. Add Fields (key/value) as required by the operation; keys come from the capability schema.
5. Run the workflow; the node calls POST /execute and returns the result data.

Credentials

• Name: Connector Engine API
• Fields: Base URL (required), API Key (required, password).

License

MIT