@gorgo/medusa-integration

中文文档
2.0.0发布于 2026/11/13MITTypeScriptESM + CJS构建来源已验证近 30 天下载 5748

Integration module for Medusa

原始使用文档
文档目录10 节
  1. What Is the Integration Module
  2. Features
  3. Available Integrations
  4. 💬 Support & Community
  5. Requirements
  6. Installation
  7. Configuration
  8. Environment Variables
  9. Documentation
  10. License

Integration Module logo

Integration Module for Medusa

Documentation
A Medusa module that lets any plugin or provider declare its options and store admins manage them in the Admin, with no medusa-config edits and no redeploys.
Читать README на русском ↗


Medusa Medusa npm version

Support Chat on Telegram

Medusa.js Chat on Telegram

Watch the Integration Module demo video

▶ Watch the demo video

What Is the Integration Module

The Integration Module lets any plugin declare its options, and store admins configure them as integrations right in the Admin, with no medusa-config edits and no redeploys. The module takes care of the UI, storage, encryption, and validation.

The Integration Module is useful for any Medusa developer building plugins, providers, or custom modules that need configurable settings, such as API keys, credentials, modes, or webhooks, but who'd rather not hand-build settings UI pages, a data layer, and validation for each one.

Features

  • Settings management in Admin: Set in the Settings → Integrations section, no medusa-config/env edits and no redeploys.
  • Any plugin, provider, or module: Works across payment, fulfillment, ERP, notification, content, and other extensions.
  • Declarative descriptor (defineIntegration): A single description of the options, settings sections, validation, and connection test.
  • Flexible typing and validation: Typed fields (string, url, email, uuid, number, boolean, enum, json) with per-option and cross-section rules, conditional visibility, and read-only fields. At runtime, the plugin gets a typed, decrypted object. Incomplete or disabled settings never resolve, so the plugin never gets an unfilled draft.
  • Encrypted secrets: Fields marked secret are encrypted (AES-256-GCM) and never reach the browser.
  • Multiple instances: The same provider can be configured more than once. For example, for several accounts in the same third-party service.
  • Connection test: Verify credentials against the third-party service right from the Admin.
  • Change history: The module records who changed which fields of an integration's settings and when. You can search and filter the history in the Admin, and secret values never reach it.
  • Extensible UI: Sections can be reordered (LayoutComposer). If the generated sections aren't enough, you can implement any UI for your options using custom widgets.
  • Integration catalog: The Admin shows the integrations from the Gorgo catalog. To add yours to it, make a Pull Request.

Available Integrations

ApiShip logo ApiShip
Fulfillment · @gorgo/medusa-fulfillment-apiship

T-Kassa logo T-Kassa by T-Bank
Payment · @gorgo/medusa-payment-tkassa

YooKassa logo YooKassa
Payment · @gorgo/medusa-payment-yookassa

Robokassa logo Robokassa
Payment · @gorgo/medusa-payment-robokassa

Stripe logo Stripe
Payment · @gorgo/medusa-payment-stripe

PayPal logo PayPal
Payment · @gorgo/medusa-payment-paypal

Authorize.net logo Authorize.net
Payment · @gorgo/medusa-payment-authorizenet

Mollie logo Mollie
Payment · @gorgo/medusa-payment-mollie

1C logo 1C:Enterprise
ERP · @gorgo-store/medusa-erp-1c

1C logo 1C:Enterprise Catalog
ERP · @gorgo/medusa-1c

Any plugin can use the Integration Module, see the documentation.

💬 Support & Community

Got questions or ideas? Join the Telegram support chat @gorgojs_chat

Connect with other Medusa developers on Telegram @medusajs_chat

The Maintenance page explains how we test, update and fix the module.

Requirements

  • Medusa v2.21.0 or later
  • Node.js v22.23.4 or later (22.x), v24.22.1 or later (24.x), or v26.12.1 or later

Installation

yarn add @gorgo/medusa-integration
# or
npm install @gorgo/medusa-integration

Configuration

Register the module in medusa-config.ts together with the providers of the plugins you install, for example T-Kassa:

module.exports = defineConfig({
  plugins: [
    {
      resolve: "@gorgo/medusa-integration",
      options: {
        encryptionKey: process.env.INTEGRATION_ENCRYPTION_KEY,
        providers: [
          {
            resolve: "@gorgo/medusa-payment-tkassa/providers/integration-tkassa",
            id: "tkassa-1",
            options: {},
          },
        ],
      },
    },
  ],
})

The module keeps integrations and their change history in its own tables. Run the migrations after you install or update it:

yarn medusa db:migrate
# or
npx medusa db:migrate

Once the migrations run, restart the server. Each registered integration appears in Medusa Admin under Settings → Integrations.

Environment Variables

  • INTEGRATION_ENCRYPTION_KEY – the passphrase you pass as the encryptionKey option. The module derives the key that encrypts options marked secret: true from it. Set it to a long random string, for example the output of openssl rand -hex 32. A provider with a secret option doesn't work without it.
  • GORGO_LICENSE – the project key from the Gorgo dashboard. Only paid Gorgo plugins need it. The module checks their licenses in the background and never blocks server startup. See Install a Paid Plugin.

Documentation

The complete installation, configuration, and usage guide is available on the Gorgo documentation website.

License

Licensed under the MIT License.

版本与发布记录

@gorgo/medusa-integration 共发布 32 个版本,首次发布于 2026/07/15;过去 12 个月发布了 32 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.0latest2026/11/134 天前
0.3.32026/11/116 天前
0.3.22026/11/0412 天前
0.3.12026/11/0116 天前
0.3.02026/10/2819 天前
0.2.92026/10/2720 天前

其他发布通道:beta → 0.3.0-beta.4。

关于 @gorgo/medusa-integration 的常见问题

@gorgo/medusa-integration 是什么?

Integration module for Medusa

如何安装 @gorgo/medusa-integration?

在项目目录运行 npm install @gorgo/medusa-integration,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@medusajs/ui(^4.1.16)、@medusajs/cli(^2.21.0)、@medusajs/deps(^2.21.0)、@medusajs/icons(^2.21.0)、@medusajs/medusa(^2.21.0)、react-router-dom(^6.30.4 || ^7.0.0)、@medusajs/admin-sdk(^2.21.0)、@medusajs/dashboard(^2.21.0)、@medusajs/framework(^2.21.0)、@medusajs/test-utils(^2.21.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gorgo/medusa-integration 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gorgo/medusa-integration 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gorgo/medusa-integration 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js ^22.23.4 || ^24.22.1 || >=26.12.1。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gorgo/medusa-integration 可以商用吗?

@gorgo/medusa-integration 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gorgo/medusa-integration 的下载量有多少?

根据 npm 官方下载统计,@gorgo/medusa-integration 在 2026/10/17 – 2026/11/15 这 30 天内被下载 5,748 次,日均约 192 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gorgo/medusa-integration 还在维护吗?

最新版本 2.0.0 发布于 2026/11/13(4 天前);至今共发布 32 个版本,其中过去 12 个月发布了 32 个;首次发布于 2026/07/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。