В этом документе вы узнаете о параметрах Модуля интеграций. Эти параметры можно передать при регистрации модуля как плагина в .
Параметры описывает тип , который экспортирует . В таблице перечислены его свойства:
Опция задаёт пароль, из которого модуль выводит ключ шифрования. Он шифрует (AES-256-GCM) каждый параметр с пометкой перед сохранением и расшифровывает эти значения обратно во время выполнения.
Задайте её при регистрации модуля:
medusa-config.ts1module.exports = defineConfig({2 // ...3 plugins: [4 {5 resolve: "@gorgo/medusa-integration",6 options: {7 encryptionKey: process.env.INTEGRATION_ENCRYPTION_KEY,8 },9 },10 ],11})
Значением может быть любая непустая строка, но для продакшена лучше подходит значение с высокой энтропией, например результат . Модуль выводит ключ один раз, при первом обращении, и затем использует его для полей всех зарегистрированных интеграций. Без модуль выбрасывает ошибку, когда сохраняет интеграцию хотя бы с одним параметром . При чтении ключ нужен, только если сохранённое значение приходится расшифровывать.
Модуль выбрасывает с типом и сообщением, которое начинается с . Для ошибок этого типа Medusa оставляет сообщение в ответе, поэтому API-роут Admin отвечает с этим сообщением, а Admin показывает его в уведомлении о неудачном сохранении.
Задайте одинаковый во всех процессах Medusa, и на сервере, и в воркере, и не меняйте его, пока интеграции хранят секреты. Значение, зашифрованное другим ключом, модуль расшифровать не может, поэтому после смены ключа получение параметров такой интеграции завершается ошибкой, как и загрузка её страницы и списка интеграций в Admin. Модуль выбрасывает с типом , и API-роут Admin отвечает с его сообщением Чтобы всё заработало, верните прежний ключ. Если он утерян, удалите затронутые интеграции через , который секреты не расшифровывает и поэтому работает без верного ключа, и настройте их заново.
Так же завершается ошибкой чтение секрета, сохранённого в версии формата, которую установленный модуль не знает, например записанного более новой версией . В этом случае модуль сообщает
Опция содержит массив провайдеров Модуля интеграций.
При старте приложения Medusa эти провайдеры регистрируются в Модуле интеграций, и их параметры становятся доступны для настройки в Admin.
Например:
medusa-config.ts1module.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})
Опция принимает массив объектов с такими свойствами:
Параметр задаёт ключ проекта из кабинета Gorgo. По нему модуль проверяет лицензию каждой установленной платной интеграции Gorgo, в фоне после запуска и затем раз в сутки. Бесплатные интеграции не проверяются, а без установленной платной интеграции модуль к сервису лицензий не обращается.
Если параметр не задан, модуль берёт ключ из переменной окружения , поэтому обычно достаточно задать переменную:
.envGORGO_LICENSE=gorgo_live_...
Проверка никогда не мешает серверу запуститься. Её результат показывается рядом с каждой платной интеграцией в Admin.
Модуль выполняет проверку в каждом процессе, который его загружает, поэтому ключ нужен и серверу, и воркеру. Если вы используете , задайте переменную в окружении обоих. Если ключа нет или он не похож на ключ проекта (), модуль не отправляет запрос в сервис лицензий, а Admin показывает Не задан ключ лицензии или Ключ лицензии в неверном формате. Если сервис лицензий недоступен, модуль повторяет запрос примерно через 15 минут, не дожидаясь следующей ежедневной проверки, а Admin пока показывает Лицензия не проверена.
Как получить ключ, читайте в разделе Лицензии на платные плагины.