Провайдеры - это источники данных, из которых CASHOFF может импортировать данные (счета, карты, операции, чеки и другие).
Существует следующие типы провайдеров:
- внешние: такие провайдеры не интегрированы с CASHOFF, работа с ними происходит по большей части за счет парсинга web-страниц ЛК провайдера
- self-провайдер: приложение выступает в качестве провайдера данных для CASHOFF
Провайдеры подключаются в виде профилей к пользователям сервиса.
Внешние провайдеры
Для подключения таких провайдеров потребуется учетная запись в ЛК провайдера, которая будет использована для авторизации профиля.
Список доступных для подключения провайдеров можно получить запросом GET /providers:
{
"items": [
{
"id": 19,
"key": "alpha",
"name": "Альфа-банк",
"type": "bank",
"logo": "https://cashoff.ru/media/logo/fi/alpha_36.svg",
"first_step": {
"key": "1",
"fields": [
{
"key": "login",
"type": "text",
"label": "Логин"
},
{
"key": "password",
"type": "password",
"label": "Пароль"
}
]
}
},
{
"id": 10,
"key": "bee",
"name": "Билайн",
"type": "cell",
"logo": "https://cashoff.ru/media/logo/fi/bee_36.svg",
"first_step": {
"key": "1",
"fields": [
{
"key": "login",
"type": "text",
"label": "Логин"
},
{
"key": "password",
"type": "password",
"label": "Пароль"
}
]
}
}
],
"total": 2
}
Список провайдеров преимущественно статичен, по этому его рекомендуется кешировать на 12 - 24 часа.
Подробнее о подключении внешних провайдеров описано в разделе Импорт данных из внешних провайдеров.
Импортируемые из провайдеров данные
Набор данных, который загружается из провайдера зависит от его типа:
| Тип провайдера | Импортируемые данные |
|---|---|
| bank (банк для физ. лиц) | Банковские продукты, операции. |
| bank_sme (банк для юр. лиц) | Банковские продукты, операции. |
| cell (мобильный оператор) | Номер телефона в виде продукта (type=cell) с балансом и доп. информацией. |
| digital_wallet (электронный кошелек) | Электронный кошелек (type=wallet) с операциями по нему |
| retail_store (магазин) | Карта лояльности (type=loyalty_card) и чеки по ней |
| gas_station (АЗС) | Карта лояльности (type=loyalty_card) и чеки по ней |
| airline (авиакомпания) | Карта лояльности (type=loyalty_card) |
| ofd (ОФД) | ККТ и чеки по ней |
Self-провайдер
Данный провайдер используется для импорта данных из приложения. Как это происходит описано в разделе Импорт данных из приложения.
Self-провайдер по умолчанию выключен и включается запросом POST /providers/self. Такой провайдер существует в единственном числе на одно зарегистрированное приложение и не отображается в общем списке провайдеров (GET /providers).
Для провайдера можно указать его название (name), которое будет использовано при отображении провайдера и данных из него в UI встраиваемых модулей CASHOFF. Если встраиваемые модули не используются, то имя указывать необходимости нет.
Если данный провайдер будет использован для импорта данных через синхронизацию, то для него нужно заполнить блок endpoints - там указываются адреса сервисов приложения, которые будут предоставлять CASHOFF данные в рамках синхронизации. Каждый тип данных имеет отдельный url (и отдельный формат запросов-ответов), который указывается полностью, с хостом и протоколом.
Для self-провайдеров не используется авторизация через реквизиты пользователя (логин, пароль, смс и т.п.). Вместо этого данные предоставляются по идентификатору пользователя за счет доверия к запросу от CASHOFF.