KeyCRM
Renta загружает аккаунт KeyCRM в ваше хранилище данных восемью типами отчётов: заказы, покупатели, компании, к которым эти покупатели относятся, товары, товарные предложения, на которые делится товар, воронки продаж, пользователи аккаунта и описания кастомных полей, заведённых в аккаунте.
В заказе деньги разложены по колонкам: сумма товаров, стоимость достав ки и упаковки, скидки, налоги, расходы, маржа, платежи и итоговая сумма. В той же строке лежат статус оплаты, фискальный статус и время, когда заказ был оформлен, закрыт и в последний раз сменил статус. У товаров и предложений к ценам, штрихкодам и габаритам добавляются остатки и резервы.
Поля каждого типа отчёта вы выбираете сами. Каждый тип отчёта перезагружается целиком на каждом запуске, поэтому таблица назначения повторяет состояние аккаунта KeyCRM на момент старта запуска.
Аутентификация
Renta подключается к KeyCRM по ключу Open API аккаунта. KeyCRM выдаёт один ключ на весь аккаунт CRM, а не отдельный ключ каждому пользователю, поэтому пайплайн видит всё, что есть в аккаунте.
Чтобы получить ключ, откройте в KeyCRM Settings > General, найдите строку API key и нажмите Generate API key.
Подключение источника KeyCRM
Выполните эти шаги, чтобы добавить KeyCRM как источник в Renta по ключу Open API аккаунта.
- Откройте раздел Connections > Catalog в левой панели.
- Откройте категорию CRM и нажмите на карточку KeyCRM.
В поле API key вставьте ключ Open API вашего аккаунта KeyCRM.
Чтобы найти его, откройте в KeyCRM Settings > General и скопируйте значение из строки API key.
- В поле Source name укажите название источника данных. Оно используется только в интерфейсе Renta.
- Нажмите Save.
Перед сохранением подключения Renta проверяет ключ в KeyCRM, поэтому ключ с опечаткой или уже заменённый не пройдёт этот шаг.
Новый источник появляется в списке Sources со статусом Active. Теперь его можно использовать в пайплайнах.
Создание пайплайна
Когда источник подключён, создайте пайплайн, чтобы синхронизировать данные KeyCRM с вашим назначением.
Создание пайплайна KeyCRM
Свяжите источник KeyCRM с назначением и настройте пайплайн.
В левой панели нажмите New pipeline. На шаге Source выберите KeyCRM в разделе Already connected и нажмите Next step.
Выберите созданное ранее подключение KeyCRM и нажмите Next step. На карточке видно название подключения и дату, когда оно было добавлено.
На шаге Destination выберите ваше назначение (например, Google BigQuery) и нажмите Next step.
Выберите подключение назначения, куда нужно загрузить данные, и нажмите Next step. На карточке видно датасет и проект, в которые попадут данные.
Настройка пайплайна
На последнем шаге выберите отчёт, его поля и расписание.
Тип отчёта
Выберите, какой объект KeyCRM выгружает пайплайн. Один пайплайн загружает один тип отчёта.
| Тип отчёта | Описание |
|---|---|
| Buyers (покупатели) | Покупатели с полным именем, датой рождения, адресами почты и номерами телефонов, назначенными менеджером и компанией, валютой и персональной скидкой, количеством и общей суммой заказов, а также признаком дубля. |
| Companies (компании) | Компании, привязанные к покупателям: название, наименование, адрес, реквизиты, назначенный менеджер и заметки. |
| Custom Fields (кастомные поля) | Описания кастомных полей, заведённых в аккаунте: название, тип, модель, к которой поле относится, позиция, а также признаки обязательности и нескольких значений. |
| Offers (товарные предложения) | Отдельные варианты, на которые делится товар: цена и закупочная цена, остаток и резерв, штрихкод и артикул, вес и габариты, свойства, которыми варианты отличаются друг от друга, а также признаки архива и варианта по умолчанию. |
| Orders (заказы) | Заказы с покупателем, статусом и группой статусов, источником, промокодом, статусом оплаты и фискальным статусом, суммой товаров, стоимостью доставки и упаковки, скидками, налогами, расходами, маржой, платежами и итоговой суммой, комментариями покупателя, клиента и менеджера, признаками подарка, а также временем оформления, закрытия и последней смены статуса. |
| Pipelines (воронки) | Воронки продаж: название, тип заявки, позиция в списке, а также признаки того, что воронка использует платежи и товары. |
| Products (товары) | Каталог товаров: название, категория, описание, диапазон цен и закупочная цена, валюта, остаток и резерв, штрихкод и артикул, единица измерения, вес и габариты, ссылки на изображения, каналы продаж, в которых размещён товар, и признак архива. |
| Users (пользователи) | Пользователи аккаунта с почтой, логином, именем, фамилией и полным именем, телефоном, ролью, статусом и временем последнего входа. |
Параметры
Выберите поля KeyCRM, которые попадут в таблицу назначения.
В каждой строке на вкладке KeyCRM fields видно на звание поля, а под ним название колонки, которую поле займёт в таблице назначения. Найдите параметр по названию через поле поиска или нажмите Select All. На вкладке Selected собрано всё, что вы выбрали, а список Selected Parameters под выбором позволяет удалить параметр.
Набор доступных полей зависит от типа отчёта, и заранее за вас ничего не выбрано. Добавляйте ID в любой пайплайн: именно по нему запись опознаётся между запусками.
Связанные записи KeyCRM отдаёт идентификаторами, а не названиями. Чтобы их раскрыть, загрузите соответствующий тип отчёта.
| Идентификатор | Тип отчёта, который его раскрывает |
|---|---|
| Client ID в Orders | Buyers |
| Company ID в Buyers | Companies |
| Manager ID в Buyers и Companies | Users |
| Product ID в Offers | Products |
Поля, в которых лежит сразу несколько значений, загружаются колонками-списками, а не дополнительными строками.
| Тип отчёта | Поля, которые загружаются колонками-списками |
|---|---|
| Buyers | Email, Phone |
| Offers | Properties |
| Orders | Fiscal Result |
| Products | Attachments Data, Sources |
Название таблицы
Задайте название пайплайна и таблицы назначения.
- Integration name.
Название пайплайна. Оно используется только в интерфейсе Renta. - Table name.
Название таблицы назначения. Можно оставить сгенерированное название или ввести своё.
Расписание
Выберите, как часто запускается пайплайн.
| Тип расписания | Описание |
|---|---|
| Manual | Пайплайн запускается только вручную через интерфейс или по API. |
| Daily | Пайплайн запускается раз в день в указанное время обновления. |
| Interval | Пайплайн запускается через указанные интервалы времени. |
| Cron Expression | Пайплайн запускается по расписанию, заданному cron-выражением. |
Для расписания Daily укажите Update time (точное время запуска), затем нажмите Create pipeline.
Новый пайплайн появляется в разделе Pipelines на вкладке ETL, где видно его запуски, прогресс и название таблицы назначения.
Стратегия синхронизации
Все типы отчётов KeyCRM Renta синхронизирует одинаково.
| Стратегия | Поддерживаемые типы отчётов | Описание |
|---|---|---|
| Полная перезагрузка | Buyers, Companies, Custom Fields, Offers, Orders, Pipelines, Products, Users | Renta на каждом запуске читает объект целиком и заменяет содержимое таблицы назначения. Таблица повторяет состояние аккаунта KeyCRM на момент запуска, а запись, которую KeyCRM перестал отдавать, уходит из таблицы на следующем запуске. |
Ready to get started?
Build your data pipeline today or get a personalized demo. Start free!
Need help?
Get expert support to ensure your project succeeds. We're here to help!
Feature requests?
Help shape our product! Share your ideas for new features and integrations.