Создание Коннектора платежного шлюза

Раздел Коннекторы платежных шлюзов доступен только корневому Реселлеру инсталляции.

Чтобы создать Коннектор платежного шлюза, необходимо:

  1. Войти в Панель управления Оператора на уровне корневого Реселлера.
  2. На Панели навигации перейти в раздел Коннекторы платежных шлюзов (см. Навигация по Панели управления Оператора). Отобразится список Коннекторов (см. Просмотр списка Коннекторов платежных шлюзов).
  3. На Панели инструментов нажать кнопку Создать. Отобразится страница Новый коннектор платежных шлюзов.



  4. В поле Название ввести имя Коннектора, которое, в частности, будет отображаться при создании Способа оплаты (см. Создание Способа оплаты).
  5. В поле URL коннектора ввести URL, на который платформа должна отправлять запросы при работе с платежным шлюзом. Пример: https://gateway.example.com
  6. В поле JSON схема указать спецификацию данных в формате JSON для описания настроек Коннектора. Значения настроек указываются позже при создании Способа оплаты (см. Создание Способа оплаты).

    JSON-схема — это массив объектов, описывающий настройки Коннектора. Он содержит типы полей, требования к их значениям и порядок отображения соответствующих HTML-элементов (текстовое поле, флажок, список и т.д.) в группе Настройки коннектора на странице Способа оплаты с типом интеграции External Payment Gateway (см. Создание Способа оплаты).

    В JSON-схеме поддерживаются следующие поля:

    Название поля

    Тип поля

    Обязательный

    Уникальный

    Описание

    typeStringДаНет

    Тип HTML-элемента:

    • string — однострочное текстовое поле.
    • password однострочное текстовое поле для ввода пароля. Вводимые символы маскируются.
    • text — многострочное текстовое поле.
    • select список для выбора одного из значений, указанных в параметре options.
    • radio группа кнопок-переключателей для выбора одного из значений, указанных в параметре options.
    • checkbox группа флажков для выбора любых значений, указанных в параметре options..
    keyStringДаДаКлюч поля
    labelStringДаДаПодпись к HTML-элементу
    hintStringНетНетТекст подсказки, который отображается при наведении на иконку возле подписи к HTML-элементу. Иконка отображается, если поле hint непустое
    requiredBooleanДаНетПризнак обязательности заполнения
    default_valueStringНетНетПредустановленное по умолчанию значение. Для типов select, radio, checkbox значение поля должно совпадать с value одного из параметров options
    optionsArray of ObjectsНетНет

    Массив объектов для формирования списка значений. Только Для типов select, radio, checkbox. Каждый объект состоит из следующих полей:

    Название поляТип поляОбязательныйОписание
    valueStringДаЗначение элемента списка
    nameStringДаОтображаемое название элемента списка
    priorityNumberНетДаПриоритет отображения. Поля с меньшим значением priority отображаются выше

    Пример JSON-схемы:

    [
      {
        "type": "string",
        "key": "api_username",
        "label": "API Username",
        "hint": "Your PayPay Username",
        "required": true,
        "default_value": "",
        "options": [],
        "priority": 1
      },
      {
        "type": "password",
        "key": "api_password",
        "label": "API Password",
        "hint": "Your PayPay Password",
        "required": true,
        "default_value": "",
        "options": [],
        "priority": 2
      },
      {
        "type": "select",
        "key": "integration_type",
        "label": "Integration Type",
        "hint": "Your Integration Type",
        "required": true,
        "default_value": "type-1",
        "options": [
          {
            "value": "type-1",
            "name": "Type 1"
          },
          {
            "value": "type-2",
            "name": "Type 2"
          }
        ],
        "priority": 3
      }
    ]

    Пример отображения настроек Коннектора согласно схеме:


  7. Нажать кнопку Создать. Платформа выполнит валидацию JSON-схемы:
    • Если JSON-схема валидна, отобразится список с созданным Коннектором платежного шлюза.
    • Если JSON-схема невалидна, отобразится сообщение с описанием проблемы.

Для созданного Коннектора платформа автоматически сгенерирует значение ключа хеш-функции (см. Просмотр и обновление информации о Коннекторе платежных шлюзов).