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
Previous PageOverview
Next PageAPI Documentation

#API Key

#Introduction

#Installation

#Usage Instructions

http://localhost:13000/admin/settings/api-keys/configuration

#Add API Key

Notes

  • The API key you add belongs to the current user and inherits the current user's role.
  • Ensure the APP_KEY environment variable is configured and kept confidential. If APP_KEY changes, all previously added API keys will become invalid.

#How to configure APP_KEY

For the docker version, modify the docker-compose.yml file

services:
  app:
    image: nocobase/nocobase:main
    environment:
+     - APP_KEY=4jAokvLKTJgM0v_JseUkJ

For the source code or create-nocobase-app installation, you can directly modify the APP_KEY in the .env file

APP_KEY=4jAokvLKTJgM0v_JseUkJ