n8n-nodes-stemconnect

This package contains a unified n8n node for integrating with the STEM Connect API, a comprehensive telecommunications management system.

Features

This package provides a single STEM Connect node that manages all telecommunications operations:

• TOCs (Take Over Certificates) - File upload/download and data submission
• ISPs (Internet Service Providers) - ISP management and configuration
• Devices - Network device management and monitoring
• End Customer Circuits - Circuit provisioning and management
• End Customers - Customer management
• VLANs - Network VLAN configuration
• Products - Service product management
• Sites - Physical site management
• Contacts - Contact management
• Billing - Billing information

Installation

1. Install the package in your n8n instance:

   npm install n8n-nodes-stemconnect

2. Restart your n8n instance to load the new nodes.

Compatibility

This package is compatible with:

• n8n versions: 1.88.0 and newer
• n8n-workflow: 1.88.0 (pinned for exact compatibility)
• Node.js versions: 18.17.0 and newer

The node has been specifically tested and optimized for compatibility with older n8n versions, including 1.88.0, to resolve URL handling issues that may occur in earlier versions. The n8n-workflow dependency is pinned to version 1.88.0 to ensure exact compatibility and prevent issues with newer workflow APIs.

Changelog

v1.0.20

• Optimized for n8n-workflow 1.88.0 with proper baseURL/url separation
• Enhanced error handling with specific error messages for timeout, SSL, and rate limiting
• Added timeout configuration (30 seconds) for better reliability
• Improved HTTP status code handling including 403, 429, and 5xx errors
• Better network error detection for connection and SSL/TLS issues

v1.0.19

• Fixed GenericFunctions.ts compatibility issues with n8n-workflow 1.88.0
• Improved error handling for better debugging and user experience
• Enhanced parameter validation for body and query string parameters
• Removed unsupported features like baseURL/url separation and timeout options
• Added comprehensive error messages for connection and authentication issues

v1.0.18

• Pinned n8n-workflow dependency to version 1.88.0 for exact compatibility
• Improved dependency management to prevent version conflicts with newer n8n-workflow APIs

v1.0.17

• Fixed compatibility with older n8n versions (1.88.0+)
• Improved URL handling to prevent "Invalid URL" errors in older axios versions
• Enhanced error handling with better error messages for debugging
• Added timeout configuration to prevent hanging requests
• Updated Node.js requirement to 18.17.0+ for better compatibility

Configuration

Credentials

Before using any of the nodes, you need to configure your STEM Connect API credentials:

1. Go to your n8n credentials settings
2. Create a new credential of type "STEM Connect API"
3. Enter your API key and base URL (default: https://om.stemconnect.net)

Available Operations

The STEM Connect node provides operations for all major telecommunications entities:

TOC Operations

• Get - Retrieve TOCs from the database with filtering options
• Upload - Upload TOC files to the server
• Submit - Submit TOC data for processing
• Download - Download TOC files from the server

ISP Operations

• Get - Retrieve all ISPs with pagination
• Add - Add new ISPs to the database
• Update - Update existing ISP information

Device Operations

• Get - Retrieve devices with filtering options
• Get by Serial - Get specific device by serial number
• Add - Add new devices to the database
• Create - Create new devices
• Update - Update device information
• Get Promo Products - Retrieve promotional products

Circuit Operations

• Get All - Retrieve all circuits with pagination
• Get - Get specific circuit by circuit number
• Add - Add new circuits
• Update - Update circuit information
• Delete - Delete circuits
• Generate TOC - Generate TOC PDF documents

Other Operations

• End Customer - Get, Add, Update end customers
• VLAN - Get, Add VLAN configurations
• Product - Get, Create products
• Site - Get, Add sites
• Contact - Get contacts
• Billing - Get billing information

API Endpoints Covered

This package covers the following STEM Connect API endpoints:

TOCs

• GET /api/tocs/get - List TOCs
• POST /api/tocs/upload - Upload TOC files
• POST /api/tocs/submit - Submit TOC data
• GET /api/tocs/download/{uniqueId} - Download TOC files

ISPs

• GET /api/isps/get - Get all ISPs
• POST /api/isps/add - Add new ISP
• POST /api/isps/update/{isp_id} - Update ISP

Devices

• GET /api/devices/get - Get devices
• GET /api/devices/get/{serial_no} - Get device by serial
• POST /api/devices/add - Add device
• POST /api/devices/create - Create device
• POST /api/devices/update/{serial_no} - Update device
• GET /api/devices/get/promo - Get promo products

End Customer Circuits

• GET /api/endcustomercircuits/get - Get all circuits
• GET /api/endcustomercircuits/get/{circuit_no} - Get circuit
• POST /api/endcustomercircuits/add - Add circuit
• PATCH /api/endcustomercircuits/update/{circuit_no} - Update circuit
• DELETE /api/endcustomercircuits/delete/{circuit_no} - Delete circuit
• POST /api/endcustomercircuits/generate-toc - Generate TOC PDF

Usage Examples

Getting All Devices

1. Add a "STEM Connect" node to your workflow
2. Set resource to "Device"
3. Set operation to "Get"
4. Configure pagination parameters (offset, limit)
5. Execute to retrieve device list

Adding a New Circuit

1. Add a "STEM Connect" node
2. Set resource to "Circuit"
3. Set operation to "Add"
4. Fill in circuit details (circuit number, speeds, PPPoE credentials)
5. Execute to create the circuit

Generating a TOC PDF

1. Add a "STEM Connect" node
2. Set resource to "Circuit"
3. Set operation to "Generate TOC"
4. Provide the circuit number
5. Execute to generate and download the TOC PDF

Managing ISPs

1. Add a "STEM Connect" node
2. Set resource to "ISP"
3. Choose operation (Get, Add, Update)
4. Configure parameters as needed
5. Execute the operation

Error Handling

All nodes include comprehensive error handling:

• API errors are properly caught and reported
• Continue on fail option available
• Detailed error messages for troubleshooting

Authentication

The nodes use API key authentication as required by the STEM Connect API:

• API key is passed in the apiKey header
• Base URL is configurable (default: https://om.stemconnect.net)

Support

For issues and questions:

1. Check the STEM Connect API documentation: https://om.stemconnect.net/api/
2. Review the n8n documentation for node development
3. Open an issue in this repository

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

Changelog

1.0.0

• Initial release
• TOCs node with full CRUD operations
• ISPs node with management capabilities
• Devices node with comprehensive device management
• Circuits node with circuit provisioning and TOC generation