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:
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)
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)
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
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
Quick Reference
Last updated