IONFLOW Gateway Documentation

IONFLOW Gateway

Welcome to the IONFLOW Gateway documentation. The Gateway is a powerful integration platform that connects e-commerce platforms with warehouse management systems (WMS), enabling seamless order synchronization, inventory management, and tracking updates across multiple sales channels.

What is the Gateway?

The Gateway serves as the central hub for managing integrations between your e-commerce platforms (Shopify, Amazon, WooCommerce, etc.) and your WMS. It provides:

• 🔄 Bidirectional Synchronization: Orders flow from stores to WMS, tracking updates flow back
• 📦 Multi-Platform Support: 20+ pre-built integrations with popular e-commerce platforms
• 🔌 RESTful API: Comprehensive API for programmatic access to integration management
• ⚙️ Flexible Configuration: Customizable parameters per integration and resource
• 🔐 Secure OAuth2 Authentication: Industry-standard security with multiple grant types
• 📊 Real-time Data: Webhooks and scheduled jobs for timely data synchronization
• 🛠️ Extensible Architecture: Create custom integrations with standardized interfaces

Key Features

Integration Management

Easily install, configure, and manage integrations with e-commerce platforms. Each integration supports multiple resources like order import, tracking updates, inventory sync, and more.

Flexible API

Access Gateway functionality through three API endpoint groups:

• USER endpoints (/api/2.0/user/*) - User and OAuth client management
• APP endpoints (/api/2.0/app/*) - Application-level integration operations
• WEBCOMPONENT endpoints (/api/2.0/webcomponent/*) - Account-scoped embedded components

Standardized Data Mapping

All integrations map platform-specific data into standardized Gateway classes (Order, Item, Address, Product, etc.), ensuring consistent data structure regardless of the source platform.

Extensible Integration Framework

Developers can create new integrations by implementing the IntegrationInterface contract and following established conventions for OAuth2 flows, data mapping, and resource actions.

Documentation Structure

This documentation is organized into four main sections:

📘 Getting Started

Quick start guide to begin using the Gateway API, including authentication setup and making your first API calls.

🔗 API Reference

Complete reference for the Gateway REST API:

• Authentication methods (OAuth2 Password Grant, Client Credentials, Account-based)
• API versioning (1.0 vs 2.0)
• Endpoint categories and usage
• Interactive Swagger documentation

⚡ App Functions

Detailed documentation for all Gateway app functions:

• Access token management
• Account operations (CRUD)
• Integration management (list, get, claim, execute actions)
• Service catalog
• Flow management
• Intent-based authorization

🛠️ Integration Development

Step-by-step guide for creating custom integrations:

• Seeder configuration (ServicesSeeder, AppServicesSeeder)
• OAuth2 flow implementation
• Integration class structure
• Data mapping requirements
• Development conventions and best practices

Quick Links

Resource	Description
Authentication Guide	Learn how to authenticate with the Gateway API
API Endpoints	Complete list of available endpoints
Integration Tutorial	Build your first custom integration
Swagger Docs	Interactive API documentation

System Requirements

Runtime:

• PHP 8.0 or higher
• Laravel 9.x
• MySQL/PostgreSQL database
• Redis (for queues and caching)

Development:

• Composer
• PHP extensions: openssl, pdo, mbstring, tokenizer, xml, ctype, json

Architecture Overview

graph LR
    A[E-commerce Platform] -->|OAuth2| B[Gateway]
    B -->|REST API| C[WMS/App]
    B -->|Webhooks| A
    C -->|REST API| B
    B -->|Queue Jobs| D[Background Workers]
    D -->|Execute| E[Integration Classes]
    E -->|Map Data| F[Standard Classes]

Flow Explanation:

1. E-commerce Platform authenticates via OAuth2 and installs integration
2. Gateway exposes REST API for apps to manage integrations
3. Background Workers execute scheduled jobs (order import, inventory sync)
4. Integration Classes handle platform-specific API calls
5. Standard Classes ensure consistent data structure

Support and Contribution

For questions, issues, or contributions:

• Documentation Issues: Report inaccuracies or request clarifications
• API Support: Contact your Gateway administrator
• Integration Requests: Submit requests for new platform integrations

Next Steps

Ready to get started? Here are some recommended paths:

For API Consumers:

1. Set up authentication
2. Make your first API call
3. Explore available functions

For Integration Developers:

1. Understand the architecture
2. Review existing integrations
3. Follow the step-by-step tutorial

For System Administrators:

1. Review API authentication methods
2. Configure OAuth2 clients
3. Set up webhook endpoints