Категории

Инструкция по установке

API Profitbase – способ интеграции Profitbase со сторонними сервисами. Мы выпустили расширенную версию API v4 и оформили её в отдельное приложение.

Возможности API

С помощью API вы сможете интегрировать Profitbase:

  • с сайтом;
  • с 1С и другими CRM-системами;
  • со своими виджетами и приложениям amoCRM и Битрикс24;
  • со сквозными системами аналитики и BI.

Основные возможности API v4:

  • работа с каталогом объектов (чтение, обновление ЖК/домов/помещений);
  • работа со сделками (при интеграции с amoCRM и Битрикс24);
  • получение планировок, фасадов;
  • получение акций.
Подключение

Зайдите в личный кабинет Profitbase, перейдите в Каталог приложений и выберите API.

Перейдите в раздел Установка и заполните форму: укажите цели интеграции, введите IP-адреса, которым понадобится доступ к API, заполните контакты и запросите подключение.

Запрос обработает техническая поддержка Profitbase и добавит ваши IP-адреса в список разрешённых для интеграции. Если в будущем вам понадобится заменить или добавить IP-адрес, напишите в техническую поддержку из аккаунта Profitbase по кнопке Помощь.

После обработки запроса в аккаунте появится поле Whitelist – здесь будет список разрешённых IP-адресов для вашего аккаунта. По умолчанию список включен, то есть без указания в заявке списка IP адресов, с которых вы будете отправлять запросы, приложение Profitbase API не будет работать.

Формирование ключа

Для создания нового API ключа Profitbase нажмите Сформировать API ключ, укажите название и назначение ключа. Назначение ключа – это конкретные задачи, которые вы хотите решать с помощью интеграции с API Profitbase. Название указывать не обязательно, оно понадобится, если вы работаете с несколькими подрядчиками – при их смене можно будет удалить конкретный ключ и сделать новый.

Как только вы нажмёте Сохранить, система сформирует API ключ. По умолчанию он будет включён. По кнопкам в строке с API ключом можно скопировать ключ или перейти к документации.

Переключатель Получать данные из CRM по умолчанию деактивирован. Если вы планируете использовать API в связке с CRM, активируйте кнопку и выберите пользователя с правами администратора в CRM.

При необходимости вы можете сформировать дополнительные API ключи – их количество не ограничено. Чтобы отключить API ключ, достаточно деактивировать переключатель.

Использование

Приложение бесплатно, если вы уже используете какое-либо платное приложение Profitbase или активировали тестовый период. Если срок оплаченных приложений истёк, API автоматически блокируется.

Если вы уже используете API Profitbase предыдущей версии, то вам нужно обновиться вручную. Для этого сформируйте ключ (он будет совпадать с вашим текущим ключом) и ознакомьтесь с документацией – в ней вы найдёте новые методы и новый адрес подключения к API.