Настоящий документ представляет собой руководство для разработчиков со стороны банковского сервиса/CRM - поставщика лидов, ответственных за подготовку банковской системы/CRM к интеграции с системой Goodfin. |
Базовое описание типов AddLead, CommonResponse и эндпоинта /ad/v1/external см. в https://sandbox.goodfin.ru/docs/shb-open-api/v1/index.html.
В песочнице (https://sandbox.goodfin.ru) доступны методы только для обучения работе со сделками. По лидам методы в песочнице не реализованы, имеется только описание типов в документации. |
Если в системе поставщика лидов добавить возможность клиенту отправлять свою заявку в Goodfin как лид, то лид будет отображен в личной кабинете клиента. Если клиент не зарегистрирован в системе, то ему будет отправлено приглашение на регистрацию в Goodfin, после выполнения которой клиент сможет обработать свой лид.
Если в системе поставщика лидов добавить возможность агенту отправлять карточку клиента/клиентов в Goodfin как лиды, то они будет доступны в личном кабинете агента на Goodfin.
Если инициатором отправки лидов будет сама система - поставщик лидов, то есть возможность указать правило обработки лида в Goodfin, а именно перечислить те банки, в которые могут быть отправлены заявки в ходе обработки лидов в системе Goodfin.
I. Для начала интеграционного взаимодействия поставщика лидов с системой Goodfin проводятся работы силами разработчиков поставщика лидов по поддержке API, предоставленного системой Goodfin. Cм. в API документации описание эндпоинта /ad/v1/external/openapi/in, а именно тип AddLead для подготовки и отправки лидов, тип CommonResponse для получения асинхронного ответа от Goodfin по результату получения лида с "SUCCESS" или "ERROR"). Также примеры сформированных лидов для передачи в Goodfin показаны в Примеры структуры передаваемого лида.
Если требуется обрабатывать изменение статусов заявок, созданных по лиду, то см. тип LeadDealApplicationStatusChanged в https://sandbox.goodfin.ru/docs/bl-open-api/v1/index.html и и пример сообщения ниже:
|
II. Далее для начала взаимодействия поставщику лидов передается логин и секрет. Эти данные должны использоваться поставщиком лидов для получения токена, чтобы поставщик лидов как система мог авторизоваться перед Goodfin как системой.
В api документации можно посмотреть метод /api/v1/oauth/token. Подробнее см. стандарт jwt.io по правилам получения и "времени жизни" токена.
III. Далее, если поставщик лидов будет передавать в Goodfin документы клиента в составе лида, то требуется предоставить системе Goodfin настройки, с помощью которых система Goodfin будет авторизовываться перед хранилищем документов поставщика лидов, чтобы иметь возможность скачать документы (см. в API описание эндпоинта /leadprovider/documentdownloadsettings/update). Ссылка для скачивания документа(ов) или ссылка для запроса конечного URL для скачивания передаётся в составе лида (см. в API документации типы Lead и LeadDocument).
IV. Отчет по результатам обработки лидов (частота, формат, объемы данных, метод передачи) согласуется с поставщиком лидов дополнительно.
Вы можете самостоятельно проверить, как будет выглядеть ваши лиды в системе Goodfin. Для этого вы можете воспользоваться тестовым окружением песочницы https://sandbox.goodfin.ru/.
Вы можете импортировать проект в Postman для тестирования: окружение: sandbox-leads.postman_environment.json коллекция: SANDBOX-LEADS.postman_collection.json |
Порядок действий