Build Universal Connector Framework + Shopify Integration
Budget: $8 – $15 CAD
Universal Connector Framework + Phase 1 Shopify Connector Integration
Objective:
Build a Universal Connector Framework from scratch that enables seamless outbound integration from Scanfluence to multiple third-party platforms (POS, CRMs, ERPs, and online carts). In Phase 1, Shopify will be the first connector implemented, also built completely from scratch to align with modern standards, ensure clean architecture, and support multi-client rollout.
Scope Summary
Components
- Universal Connector Framework | Core abstraction and logic handler for connectors (Connector Interface + Factory + Utilities)
- Shopify Connector (Public App - Unlisted) | First real implementation of the framework, built from scratch using OAuth-based integration for Shopify stores |
System Flow & Architecture
The Universal Connector Framework acts as a middleware bridge between Scanfluence (internal system) and third-party connectors (external platforms like Shopify, DEAR, etc.).
Flow Summary:
- Scanfluence System - Normalized Campaign, Validation Request
- Universal Connector Framework
- Connectors (example)
o [Shopify Connector] --> Shopify Admin API
o ABC POS Connector] --> ABC POS API
Two-Sided Integration Responsibilities
Layer | Responsibilities |
- Scanfluence - Campaign creation<br>- Coupon validation requests<br>- Redemption tracking UI/dashboard |
- Connector Framework - Accept incoming API calls from Scanfluence<br>- Normalize data and log all requests<br>- Route to correct connector via factory<br>- Return response to Scanfluence
- Connectors (e.g. ShopifyConnector) | - Authenticate to external system<br>- Push campaign details<br>- Validate coupon codes<br>- Confirm redemption & sync usage |
Development Tasks (with Cursor AI collaboration)
1. Base Connector Interface
- Define BaseConnector interface with methods:
- pushDiscount(campaign)
- validateCoupon(code, product)
- redeemCoupon(code)
- Use TypeScript interface and enforce consistent contract
- Estimate: 3–4 hrs
2. Connector Factory Loader
- Create ConnectorFactory.ts to:
- Load the appropriate connector class based on store config
- Example: getConnector(store).pushDiscount(...)
- Estimate: 4 hrs
3. Shopify Connector (Fresh Build)
- Build ShopifyConnector.ts completely from scratch
- Implements all methods from BaseConnector
- Use Shopify Admin API with public OAuth (Unlisted App)
- Push campaign data (discount title, code, type, start/end)
- Handle and log API responses, sync failures
- Estimate: 10–12 hrs
4. Auth Handling
- OAuth flow for Shopify with token mgmt
- Basic Auth setup for Scanfluence API requests
- Use secure key storage via .env or Secrets Manager
- Estimate: 4 hrs
5. Error Logging + Retry Strategy
- Log connector success/failure attempts (storeId, connector type, timestamp)
- Implement retry/fallback for temporary outages
- Use Winston logger or equivalent
- Estimate: 3 hrs
6. Inbound API Layer (Scanfluence-triggered)
- Build express routes like:
- POST /sync/campaign
- POST /validate-coupon
- POST /redeem-coupon
- Integrate with factory & connector pattern
- Estimate: 3 hrs
7. Testing Shopify Connector
- Use predefined campaign object to simulate push
- Validate sync, coupon validation, and redemption via Shopify Checkout
- Estimate: 4 hrs
8. Documentation & Developer Onboarding
- Describe folder structure, interface, how to add a new connector
- Installation + OAuth setup for Shopify connector
- Estimate: 3 hrs
Total Estimated Time: 34–38 hours
Deliverables
- Connector Framework built from scratch
- Fully functioning Shopify Connector (new build)
- Secure OAuth-compliant connector, ready for multi-client rollout
- Logging, retry logic, and testable sync operations
- Inbound API layer for Scanfluence to send sync and validation triggers
- Documentation and onboarding guide for future developers
Security Checklist
- HTTPS for all traffic
- OAuth with scope restriction & token expiry
- Basic Auth for Scanfluence APIs using encoded secretKey:accessKey:storeId
- No secrets in codebase – use environment configs
Tech Stack
- Language: TypeScript (Node.js, Angular)
- Framework: Remix (if applicable)
- DB: PostgreSQL or MongoDB
- Auth: OAuth2, Basic Auth
- Infrastructure: AWS (Secrets Manager, S3, Logs)
This comprehensive specification reflects the updated plan to:
- Build the Universal Connector Framework from scratch
- Create the Shopify connector from scratch (not reusing legacy code)
- Support two-sided integration between Scanfluence and external systems
- Lay a robust foundation for future connectors
Assumptions:
• The estimate should be based on development work with Cursor AI collaboration
• The universal Connector Framework is
o Modular design to support both cloud-native and on-premise POS environments
o Edge connector ready – lightweight local services can bridge a legacy POS system to the cloud
o Seamless Integration to Edge connectors without any core changes.
• Shopify review and approval coordination
Objective:
Build a Universal Connector Framework from scratch that enables seamless outbound integration from Scanfluence to multiple third-party platforms (POS, CRMs, ERPs, and online carts). In Phase 1, Shopify will be the first connector implemented, also built completely from scratch to align with modern standards, ensure clean architecture, and support multi-client rollout.
Scope Summary
Components
- Universal Connector Framework | Core abstraction and logic handler for connectors (Connector Interface + Factory + Utilities)
- Shopify Connector (Public App - Unlisted) | First real implementation of the framework, built from scratch using OAuth-based integration for Shopify stores |
System Flow & Architecture
The Universal Connector Framework acts as a middleware bridge between Scanfluence (internal system) and third-party connectors (external platforms like Shopify, DEAR, etc.).
Flow Summary:
- Scanfluence System - Normalized Campaign, Validation Request
- Universal Connector Framework
- Connectors (example)
o [Shopify Connector] --> Shopify Admin API
o ABC POS Connector] --> ABC POS API
Two-Sided Integration Responsibilities
Layer | Responsibilities |
- Scanfluence - Campaign creation<br>- Coupon validation requests<br>- Redemption tracking UI/dashboard |
- Connector Framework - Accept incoming API calls from Scanfluence<br>- Normalize data and log all requests<br>- Route to correct connector via factory<br>- Return response to Scanfluence
- Connectors (e.g. ShopifyConnector) | - Authenticate to external system<br>- Push campaign details<br>- Validate coupon codes<br>- Confirm redemption & sync usage |
Development Tasks (with Cursor AI collaboration)
1. Base Connector Interface
- Define BaseConnector interface with methods:
- pushDiscount(campaign)
- validateCoupon(code, product)
- redeemCoupon(code)
- Use TypeScript interface and enforce consistent contract
- Estimate: 3–4 hrs
2. Connector Factory Loader
- Create ConnectorFactory.ts to:
- Load the appropriate connector class based on store config
- Example: getConnector(store).pushDiscount(...)
- Estimate: 4 hrs
3. Shopify Connector (Fresh Build)
- Build ShopifyConnector.ts completely from scratch
- Implements all methods from BaseConnector
- Use Shopify Admin API with public OAuth (Unlisted App)
- Push campaign data (discount title, code, type, start/end)
- Handle and log API responses, sync failures
- Estimate: 10–12 hrs
4. Auth Handling
- OAuth flow for Shopify with token mgmt
- Basic Auth setup for Scanfluence API requests
- Use secure key storage via .env or Secrets Manager
- Estimate: 4 hrs
5. Error Logging + Retry Strategy
- Log connector success/failure attempts (storeId, connector type, timestamp)
- Implement retry/fallback for temporary outages
- Use Winston logger or equivalent
- Estimate: 3 hrs
6. Inbound API Layer (Scanfluence-triggered)
- Build express routes like:
- POST /sync/campaign
- POST /validate-coupon
- POST /redeem-coupon
- Integrate with factory & connector pattern
- Estimate: 3 hrs
7. Testing Shopify Connector
- Use predefined campaign object to simulate push
- Validate sync, coupon validation, and redemption via Shopify Checkout
- Estimate: 4 hrs
8. Documentation & Developer Onboarding
- Describe folder structure, interface, how to add a new connector
- Installation + OAuth setup for Shopify connector
- Estimate: 3 hrs
Total Estimated Time: 34–38 hours
Deliverables
- Connector Framework built from scratch
- Fully functioning Shopify Connector (new build)
- Secure OAuth-compliant connector, ready for multi-client rollout
- Logging, retry logic, and testable sync operations
- Inbound API layer for Scanfluence to send sync and validation triggers
- Documentation and onboarding guide for future developers
Security Checklist
- HTTPS for all traffic
- OAuth with scope restriction & token expiry
- Basic Auth for Scanfluence APIs using encoded secretKey:accessKey:storeId
- No secrets in codebase – use environment configs
Tech Stack
- Language: TypeScript (Node.js, Angular)
- Framework: Remix (if applicable)
- DB: PostgreSQL or MongoDB
- Auth: OAuth2, Basic Auth
- Infrastructure: AWS (Secrets Manager, S3, Logs)
This comprehensive specification reflects the updated plan to:
- Build the Universal Connector Framework from scratch
- Create the Shopify connector from scratch (not reusing legacy code)
- Support two-sided integration between Scanfluence and external systems
- Lay a robust foundation for future connectors
Assumptions:
• The estimate should be based on development work with Cursor AI collaboration
• The universal Connector Framework is
o Modular design to support both cloud-native and on-premise POS environments
o Edge connector ready – lightweight local services can bridge a legacy POS system to the cloud
o Seamless Integration to Edge connectors without any core changes.
• Shopify review and approval coordination