LogoDev portal

API Documents

Comprehensive overview of all gateway APIs in the iMBRACE ecosystem. Explore our three main gateways designed for different use cases and integration scenarios.

API Documents

Welcome to the iMBRACE API Documentation hub! This comprehensive guide provides access to all gateway APIs within our ecosystem, designed to support various integration scenarios from client applications to backend services and workflow automation.

Our API ecosystem is built with scalability, security, and developer experience in mind. Each gateway serves specific purposes and use cases, ensuring optimal performance and clear separation of concerns.

Gateway Overview

Our system architecture includes three main gateways, each designed for specific integration scenarios:

📱

App Gateway

Public APIs designed for client applications including mobile apps, web applications, and third-party integrations. Features OTP-based authentication and comprehensive data management.

✓User Management (5 endpoints)
✓AI Agent Management (7 endpoints)
✓Data Board CRUD (18 endpoints)
✓Contacts & Notifications (6 endpoints)
✓Team Management (20 endpoints)
✓Settings & Templates (12 endpoints)
✓Conversations (7 endpoints)
✓Workflow Management (12 endpoints)
Explore App APIs→
⚙️

Server Gateway

Private APIs for secure backend integration and data synchronization. Requires token-based authentication and is designed for internal system communication.

✓Data Board Management (12 endpoints)
Explore Server APIs→
🛤️

Journey API

Developer portal APIs for building, managing, and publishing custom applications within the iMBRACE ecosystem. Supports workflow automation and app lifecycle management.

✓Workflow Management & Verification
✓AI Assistant Creation & Management
✓App Submission & Settings
✓Channel Integration
✓Data Board Item Management
✓Developer Portal Access
Explore Journey APIs→

API Features & Capabilities

🔐 Security & Authentication

✓OTP-based authentication (password-free)
✓Multi-organization support with role-based access
✓Token-based authentication for private APIs
✓Team-based access control and permissions
✓Rate limiting and abuse protection
✓HTTPS encryption for all endpoints

🤖 AI & Automation

✓AI Agent creation and management with custom prompts
✓Workflow automation and orchestration
✓Multi-channel AI assistant integration
✓Custom AI templates and configurations
✓Workflow verification and testing

📊 Data Management

✓Dynamic data boards with custom fields (18 field types)
✓Advanced filtering and search capabilities
✓File upload and management with multiple formats
✓CSV export and data migration tools
✓Bulk operations for large datasets
✓Data validation and constraints

💬 Communication & Integration

✓Multi-channel communication (WhatsApp, Facebook, Instagram, WeChat, LINE, Email)
✓Real-time notifications and updates
✓Conversation history and context preservation
✓Message templates and email templates
✓Developer portal for custom app creation
✓Team collaboration and assignment features

Environment Information

Available Environments

Production

Live environment for production use

app-gateway.imbrace.co
Demo

Testing environment for demo

app-gateway.demo.imbrace.co
Development

Development environment for testing

app-gateway.dev.imbrace.co

API Endpoint Structure

App Gateway: /v1/backend/ and /v2/backend/ for public APIs
Server Gateway: /3rd/ for private backend APIs with token authentication
Journey API: /journeys/api/v1/ and /journeys/v2/ for workflow and app management

Quick Reference

API Summary by Category

App Gateway APIs

87+ Endpoints across 9 categories
• User Management (5)
• AI Agents (7)
• Data Boards (18)
• Teams (20)
• Settings (12)
• Conversations (7)
• Workflows (12)
• Contacts (6)
• Channels (comprehensive)

Server Gateway APIs

12+ Endpoints for private integration
• Data Board Management

Journey API

Developer Portal APIs
• Workflow Management
• AI Assistant Creation
• App Submission
• Channel Integration
• Data Board Items
• App Settings

Overview

A concise, high-level introduction to the iMBRACE Developer Portal — your central hub for building, integrating, and managing applications across the iMBRACE ecosystem.

App Gateway

Build powerful applications using iMBRACE's comprehensive API suite. Create web apps, mobile apps, or integrate with existing systems using our enterprise-grade APIs for user management, AI automation, data handling, and multi-channel communication.

On this page

API DocumentsGateway OverviewAPI Features & CapabilitiesEnvironment InformationQuick Reference