В этом документе вы узнаете о параметрах Модуля интеграций. Эти параметры можно передать при регистрации модуля как плагина в medusa-config.ts.

Опция encryptionKey задаёт пароль, из которого модуль выводит ключ шифрования. Он шифрует (AES-256-GCM) каждый параметр с пометкой secret: true перед сохранением и расшифровывает эти значения обратно во время выполнения.

Задайте её при регистрации модуля:

medusa-config.ts
1module.exports = defineConfig({
2  // ...
3  plugins: [
4    {
5      resolve: "@gorgo/medusa-integration",
6      options: {
7        encryptionKey: process.env.INTEGRATION_ENCRYPTION_KEY,
8      },
9    },
10  ],
11})

Значением может быть любая непустая строка, но для продакшена лучше подходит значение с высокой энтропией, например результат openssl rand -hex 32. Модуль выводит ключ один раз, при первом обращении, и затем использует его для полей secret всех зарегистрированных интеграций. Без encryptionKey модуль выбрасывает ошибку при первой попытке сохранить или прочитать интеграцию с хотя бы одним параметром secret: true.

Опция providers содержит массив провайдеров Модуля интеграций.

При старте приложения Medusa эти провайдеры регистрируются в Модуле интеграций, и их параметры становятся доступны для настройки в Admin.

Например:

medusa-config.ts
1module.exports = defineConfig({
2  // ...
3  plugins: [
4    {
5      resolve: "@gorgo/medusa-integration",
6      options: {
7        providers: [
8          {
9            resolve: "@gorgo/medusa-payment-my/providers/integration-my",
10            id: "my-1",
11            options: {},
12          },
13        ],
14      },
15    },
16  ],
17})

Опция providers принимает массив объектов с такими свойствами:

• resolve: строка с именем пакета провайдера Модуля интеграций или путь до него.
• id: необязательная строка, задающая конкретную регистрацию. Не указывайте её для единственного безымянного инстанса провайдера, либо задайте её, чтобы зарегистрировать несколько инстансов одного и того же провайдера.
• options: объект с собственными параметрами провайдера.