logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo
Overview

API

API Keys
API Documentation
Usage Scenarios
SSO

Workflow

Webhook
HTTP Request
External Data Sources

Foreign Data Tables (FDW)

Overview
Enable MySQL Federated

Embedded Content

Iframe Block
Embed
Next PageAPI Keys

#Integration

#Overview

NocoBase provides comprehensive integration capabilities, allowing seamless connection with external systems, third-party services, and various data sources. Through flexible integration methods, you can extend NocoBase's functionality to meet diverse business needs.

#Integration Methods

#API Integration

NocoBase provides powerful API capabilities for integrating with external applications and services:

20250301003106

  • API Keys: Secure authentication using API keys for programmatic access to NocoBase resources
  • API Documentation: Built-in API documentation for exploring and testing endpoints

#Single Sign-On (SSO)

Integrate with enterprise identity systems for unified authentication:

auth_sso-2025-11-24-08-26-46

  • SSO Integration: Support for SAML, OIDC, CAS, LDAP, and third-party platform authentication
  • Centralized user management and access control
  • Seamless authentication experience across systems

#Workflow Integration

Connect NocoBase workflows with external systems:

auth_sso-2025-11-24-12-02-01

  • Workflow Webhook: Receive events from external systems to trigger workflows
  • Workflow HTTP Request: Send HTTP requests to external APIs from workflows
  • Automate business processes across platforms

#External Data Sources

Connect to external databases and data systems:

20240512085558

  • External Databases: Directly connect to MySQL, PostgreSQL, MariaDB, MSSQL, Oracle, and KingbaseES databases
  • Recognize external database table structures and perform CRUD operations on external data directly within NocoBase
  • Unified data management interface

#Embedded Content

Embed external content within NocoBase:

20240408220322

  • Iframe Block: Embed external web pages and applications
  • JS Blocks: Execute custom JavaScript code for advanced integrations

#Common Integration Scenarios

#Enterprise System Integration

  • Connect NocoBase with ERP, CRM, or other enterprise systems
  • Synchronize data bidirectionally
  • Automate cross-system workflows

#Third-Party Service Integration

  • Query payment status from payment gateways, integrate messaging services, or cloud platforms
  • Leverage external APIs to extend functionality
  • Build custom integrations using webhooks and HTTP requests

#Data Integration

  • Connect to multiple data sources
  • Aggregate data from different systems
  • Create unified dashboards and reports

#Security Considerations

When integrating NocoBase with external systems, consider the following security best practices:

  1. Use HTTPS: Always use encrypted connections for data transmission
  2. Secure API Keys: Store API keys securely and rotate them regularly
  3. Principle of Least Privilege: Grant only necessary permissions for integrations
  4. Audit Logging: Monitor and log integration activities
  5. Data Validation: Validate all data from external sources