Getting Started

Welcome to the iMBRACE Server Gateway! This guide will help you get started with our server-to-server API integration.

1. What is Server Gateway?

The Server Gateway provides APIs that allow your server or workflow engine to call iMBRACE services directly. This is designed for:

  • Server-to-Server Integration - Your backend systems calling iMBRACE APIs

  • Workflow Engine Integration - Workflow engines like n8n, Zapier, or custom systems

  • Data Synchronization - Automated data flow between your systems and iMBRACE

  • Bulk Operations - Processing large datasets programmatically

2. Quick Setup

  1. Get Access Token - Contact iMBRACE support for your organization's access token

  2. Configure Your Server - Set up your server or workflow engine to call iMBRACE APIs

  3. Start Integrating - Begin calling iMBRACE services from your systems

3. Authentication

Server Gateway uses token-based authentication. Include your token in every request:

curl -H "x-access-token: your-access-token-here" \
     -H "Content-Type: application/json" \
     https://app-gateway.dev.imbrace.co/3rd/boards

4. Environments

Environment
Base URL
Purpose

Production

https://app-gateway.imbrace.co/3rd/

Live environment

Demo

https://app-gateway.demo.imbrace.co/3rd/

Testing environment

Development

https://app-gateway.dev.imbrace.co/3rd/

Development environment

5. API Documentation

📊 Data Board APIs

  • Data Board Management - Complete data board operations, CRUD operations, field management, and bulk data processing

🤖 AI Agent Server Gateway APIs

  • AI Agent Server Gateway APIs - Complete AI Agent operations, RAG operations, and ECharts operations

6. Common Use Cases

Workflow Engine Integration

# Your workflow engine calls iMBRACE APIs
POST /3rd/boards/create/brd_123/board_items
PUT /3rd/boards/update/brd_123/board_items
GET /3rd/boards/brd_123/export_csv

Server Integration

# Your server synchronizes data with iMBRACE
GET /3rd/boards/{board_id}/board_items
POST /3rd/board_search/{board_id}/search
POST /3rd/boards/{board_id}/import_csv

Data Pipeline

# Automated data processing workflows
POST /3rd/boards/_fileupload
POST /3rd/boards/{board_id}/import_csv
GET /3rd/boards/{board_id}/export_csv

7. Next Steps

  1. Get Your Token - Contact iMBRACE support for access

  2. Read the Documentation - Explore detailed API documentation

  3. Set Up Your Integration - Configure your server or workflow engine

  4. Test Your Integration - Start with development environment

  5. Deploy to Production - Move to production when ready

Need help? Contact our support team for assistance with your server integration.

Last updated