В этом справочнике перечислены методы IntegrationModuleService, основного сервиса Модуля интеграций. Код с доступом к контейнеру Medusa, например API-роут, подписчик, запланированная задача или шаг воркфлоу, получает его по ключу INTEGRATION_MODULE:

src/api/admin/my-integration/route.ts
1import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
2import { INTEGRATION_MODULE, IntegrationModuleService } from "@gorgo/medusa-integration"
3
4export async function GET(req: MedusaRequest, res: MedusaResponse) {
5  const integrationModuleService: IntegrationModuleService = req.scope.resolve(INTEGRATION_MODULE)
6
7  const { integrations } = await integrationModuleService.listIntegrationsOverview({ category: "payment" })
8
9  res.json({ provider_ids: integrations.map((integration) => integration.provider_id) })
10}

listIntegrationsOverview возвращает все зарегистрированные платёжные инстансы с их состоянием, а роут отдаёт их ключи. Провайдер в изолированном контейнере своего модуля так получить сервис не может, поэтому читает параметры через resolveIntegrationOptions, подробнее в руководстве Чтение параметров.

---

UiDescriptor описывает descriptor, который возвращает GET /admin/integrations/:provider_id, с identifier, instanceId и category дескриптора, его i18n-ключами и иконкой, раскладкой, hasTestConnection и sections с их fields. Корень пакета экспортирует его вместе с UiSection и UiField, типами секции и поля.

---

Корень пакета экспортирует IntegrationOverviewQuery, IntegrationOverviewResult и IntegrationOverviewItem, типы метода listIntegrationsOverview.

Методы getStoredValues, isComplete, listIntegrationsOverview и getResolvedOptions расшифровывают сохранённые секреты, и encryptionKey нужен им, только если в записи есть значение, которое нужно расшифровать. Они бросают MedusaError с типом unexpected_state, если encryptionKey не задан, если это не тот ключ, с которым секрет сохранили, или если секрет хранится в версии формата, которую установленный модуль не знает. Сообщения об ошибках и то, как сохранить ключ неизменным, описаны в разделе Параметры Модуля интеграций. Как эти методы читают значение, сохранённое до смены флага secret у параметра, читайте на странице Дескриптор провайдера интеграций.

---

---

Чтобы прочитать сами записи, используйте сгенерированные методы IntegrationChange ниже. Они возвращают сохранённые строки как есть. В отличие от API-роутов Admin, они не скрывают значения параметров, которые стали секретными после записи изменения. Корень пакета экспортирует IntegrationChangeUser и IntegrationChangeField.

---

Элемент каталога типа CatalogItem представляет собой запись каталога Gorgo с полями integrationId, slug, npm, category, label и другими, к которым добавлены installed и provider_id. Запись о лицензии типа LicenseStateEntry представляет собой вердикт по одному npm-пакету с полями package, state, checked_at, subscription, latest_allowed_version и identifiers провайдеров, которые поставляет пакет. Корень пакета экспортирует оба типа. Admin API возвращает те же структуры, его роуты описаны в разделе Каталог и лицензии.

---

Сервис расширяет MedusaService из Medusa, который генерирует методы управления данными для обеих моделей данных:

• для Integration: listIntegrations, listAndCountIntegrations, retrieveIntegration, createIntegrations, updateIntegrations, deleteIntegrations, softDeleteIntegrations и restoreIntegrations;
• для IntegrationChange: listIntegrationChanges, listAndCountIntegrationChanges, retrieveIntegrationChange, createIntegrationChanges, updateIntegrationChanges, deleteIntegrationChanges, softDeleteIntegrationChanges и restoreIntegrationChanges.

Для чтения используйте методы list и retrieve. Они возвращают записи типов Integration и IntegrationChange, которые экспортируются из корня пакета. В сохранённых options записи Integration секреты хранятся зашифрованными. Параметры этих методов описаны в справочнике по фабрике сервисов Medusa.