Интеграция OSMI Cards

Как настроить интеграцию OSMI Cards

Порядок настройки, ограничения и возможности указаны по ссылке (Интеграция с OSMI Cards).

Создать точку интеграции

Тип пресета — «Другое. Для создания и настройки интеграции с внешней системой.»

Снимок экрана 2023-03-21 в 07.35.43.png

Создать шаблон действия

1. UpdateCard
Обновление электронной карты

Снимок экрана 2021-04-21 в 16.06.05.png

Создать балльный счет

Если бальный счет создан, то этот шаг можно пропустить.

Снимок экрана 2021-05-28 в 15.18.01.png

Создать дополнительные поля

1. WalletCardLink

Ссылка на установку электронной карты

Снимок экрана 2021-04-28 в 15.40.25.png

2. WalletCardSubscription

Подписан на рассылки

Снимок экрана 2021-04-28 в 15.41.16.png

3. WalletCardQrCodeLink

Ссылка на qr-код установки карты

Снимок экрана 2021-04-28 в 15.41.50.png

Создать тип дисконтных карт

Снимок экрана 2023-03-21 в 08.26.04.png

Импортировать дисконтные карты

В файле укажите для карт созданный в предыдущем пункте тип.

Снимок экрана 2024-09-11 в 22.35.30.png

Создать вебхуки

Создать вебхук необходимо после того, как менеджер OSMI Cards передаст вам шаблон.

1. Создание карты OSMI

POST

https://[URL полученный от OSMI или клиента]/v2t/passes/${Recipient.Card.[тип карты].Number}/[название шаблона дизайна дисконтной карты полученный от OSMI или клиента]?withValues=true&transactionId=${WebhookRequest.TransactionalId}

Content-Type

application/json

Authorization

Bearer xxxxx где xxxxx это токен, который получен от менеджера OSMI

Тело запроса

{
"values": [
    {
    "label": "[название поля "клиент" полученное от OSMI или клиента]",
    "value": "@{if IsEmpty(Recipient.OnlyStandardFirstName)}@{ else }${Recipient.FirstAndLastName}@{end if}"
    },
    {
    "label": "["название поля "баллы" полученное от OSMI или клиента]",
    "value": "${Recipient.GetBonusPointsAccount("[название бального счета в Mindbox]").Available}"
    }
],
   "barcode": {
        "show": true,
        "showSignature": true,
        "message": "${Recipient.Card.AnyType.Number}",
        "signature": "${Recipient.Card.AnyType.Number}"
    }
}

2. Обновление баланса карты OSMI

PUT

https://[URL полученный от OSMI или клиента]/v2t/passes/${Recipient.Card.[тип карты].Number}?transactionId=${WebhookRequest.TransactionalId}&push=true

Content-Type

application/json

Authorization

Bearer xxxxx где xxxxx это токен, который получен от менеджера OSMI

Тело запроса

{
"values": [
    {
    "label": "[название поля "клиент" полученное от OSMI или клиента]",
    "value": "@{if IsEmpty(Recipient.OnlyStandardFirstName)}@{ else }${Recipient.FirstAndLastName}@{end if}"
    },
    {
    "label": "[название поля "баллы" полученное от OSMI или клиента]",
    "value": "${Recipient.GetBonusPointsAccount("[название бального счета в Mindbox]").Available}"
    }
],
   "barcode": {
        "show": true,
        "showSignature": true,
        "message": "${Recipient.Card.AnyType.Number}",
        "signature": "${Recipient.Card.AnyType.Number}"
    }
}

В теле запроса могут быть дополнительные параметры полей, в зависимости от потребностей клиента. 

Создать сценарии

1. OSMI - Изменение баланса

  • Событие — «Изменение баланса» в выбранном счете:

    Снимок экрана 2023-03-21 в 07.53.26.png

  • Группа шагов — вызвать вебхук и выдать действие:

    Снимок экрана 2023-03-21 в 07.58.40.png

2. OSMI - Создание карты

  • Событие — зависит от выборки, которая должна получить карты. Это может быть любое попадание в базу или регистрация через определенную операцию, например:

    Снимок экрана 2023-05-25 в 18.12.30.png

  • Проверяем, что нет карт OSMI:

    Снимок экрана 2023-05-25 в 18.14.17.png

  • Выдаем карту и вызываем вебхук:

    Снимок экрана 2023-05-25 в 18.16.30.png

  • Ограничиваем срабатывание одним разом на клиента:

    Снимок экрана 2023-05-25 в 18.16.45.png

Создать операции

Операции необходимо создавать с теми настройками и именами, которые указаны в инструкции:

1. Wallet.BindCard

Снимок экрана 2021-04-21 в 16.12.46.png

2. Wallet.CheckCustomerByMobilePhone

Снимок экрана 2021-07-02 в 11.12.13.png

3. Wallet.EditCustomer

Снимок экрана 2021-07-02 в 11.11.25.png

4. Wallet.RegisterCustomer

Снимок экрана 2021-07-02 в 11.10.30.png

5. Wallet.SubscribeCard

Снимок экрана 2021-07-02 в 11.09.53.png

6. Wallet.UnsubscribeCard

Снимок экрана 2021-07-02 в 11.08.52.png

7. Wallet.UpdateCard

Снимок экрана 2023-05-25 в 17.56.40.png

8. Wallet.SetCardLink

Снимок экрана 2021-07-02 в 11.07.55.png

Интеграция сайта с платформой Mindbox: получение данных с сайта, из мобильного приложения, лендингов, программы лояльности, офлайн-точек, CRM-систем.