Функционал Пинкитбилдер позволяет добавить любой сервис с открытым API, а также события и действия для него в личный кабинет Пинкит без разработки. В статье покажем, как это сделать на примере сервиса Аспро Cloud.
1. Как настроить интеграцию с сервисом, которого нет в Пинкит. Проблема и решение
У нашего заказчика, который использует Пинкит, возникла необходимость передачи данных между Битрикс24 и Аспро.Cloud (облачная CRM). Но добавить ее самостоятельно он не смог — в личном кабинете Пинкит не было авторизации для Аспро Cloud.
Приватные интеграции в Пинкит против публичных интеграций с помощью Пинкитбилдер: подробности в статье.
Пинкитбилдер — это конструктор, который был добавлен в личный кабинет Пинкит, чтобы у пользователя появилась возможность решения его интеграционных задач. При этом пользователь может самостоятельно добавить сервис, события и действия (триггеры) и протестировать API конкретного сервиса.
Далее приведем краткую инструкцию, как работать с Пинкитбилдер.
2. Авторизация
Чтобы добавить авторизацию к сервису через Пинкитбилдер, выполняем следующие действия.
2.1. В личном кабинете Пинкит, переходим в раздел "Пинкитбилдер".
2.2. Попадаем в раздел "Сервисы" и нажимаем "Добавить сервис".
2.3. Открываем API-документацию сервиса, который нужно добавить (разберем на примере Аспро Cloud).
2.4. Заполняем поля:
Название сервиса - Аспро Cloud
Алиас (системное название) - aspro.cloud
Базовый URL - это одинаковая часть во всех запросах к сервису, берем из документации, в нашем случае это будет https://{{company}}.aspro.cloud/api/v1/module/.
2.5. Добавляем иконку для сервиса. Нажимаем Добавить.
Сервис появится в общем списке сервисов. Если вы указали что доступ приватный, то новый сервис увидите только вы.
Если нужно внести изменения в настройки, нажмите на шестеренку и попадете во всплывающее окно с настройками:
2.6. Нажимаем "Просмотр":
2.7. Открываются дополнительные настройки:
2.8. Заходим в "Доступ" и выбираем нужный тип доступа.
В Пинкитбилдер добавлены 7 самых распространенных типов авторизации:
- Basic-аутентификация
- API-ключ в обмен на логин и пароль
- Логин и пароль
- IMAP
- Анонимный
- OAuth 2 + Basic-аутентификация
- OAuth 1
Какие способы авторизации есть у вашего сервиса, можно найти в документации к нему.
2.9. Добавим авторизацию через API ключ. Выбираем тип доступа API ключ и заполняем поля в настройках авторизации:
Способ передачи API ключа - GET-параметр;
Название параметра - api_key.
Нажимаем Сохранить и продолжить.
2.10. Настраиваем поля формы, которые будут подставляться автоматически.
Подстановка - указываем параметр из базового URL {{your_company}}
Тип поля - выбираем тип поля, например, текст
Отображаемое название - Компания
Системное название поля - company
2.11. Фильтры события
Если на шаге 1 настройки интеграции вам нужна дополнительная фильтрация, вы можете добавить ее в разделе "Фильтры":
2.12. Авторизуемся в личном кабинете Пинкит.
Переходим в личный кабинет, раздел "Доступы". нажимаем Добавить, еще раз вводим API ключ и добавляем доступ:
3. Добавление события на шаг 1
Предварительно добавим сущности сервиса в разделе "Сущности". Например, сущность Контакт:
3.1. Заходим в настройки сервиса - События.
3.2. Находим в документации нужный метод для получения списка контактов (контрагентов):
3.3. Переходим в раздел "События" и нажимаем Добавить.
3.4. Добавим событие Контрагент - Создан:
Тип события - поллинг
Метод отправки запроса - GET
URL запроса - crm/account/list
3.5. Нажимаем Сохранить и продолжить. Событие добавлено.
4. Добавление действия на шаг 3
Настройки добавляем аналогично, в разделе Действия.
5. Итог
Резюмируем.
Если вам нужно настроить интеграцию с сервисом, которого нет в Пинкит, но у сервиса есть документация по API, то вы можете самостоятельно протестировать решение вашей бизнес-задачи путем добавления авторизации, событий и действий через Пинкитбилдер.
Это дает вам возможность проверить, работает ли API нужного вам сервиса так, как вам требуется, и как итог получить решение вашей бизнес-задачи без разработки.
Остались вопросы? Спросите у нас в Телеграм или WhatsApp.
Если вам нужна интеграция с сервисом, которого в Пинкит нет, или кастомизированное событие/действие, через Пинкитбилдер вы можете самостоятельно добавить авторизацию, необходимые события и действия без разработки. Протестируйте Пинкит, зарегистрировавшись в личном кабинете по ссылке: https://lk.pinkit.io/register.
Алексей Окара, продакт-менеджер Пинкит
#пинол #пинкит #pinall #pinkit #bitrix24 #битрикс24 #amo #amocrm #амо #амоцрм #crm #црм #црмсистема #црм_система #внедрениецрм #интеграция #миграция #обмен #пинкитбилдер