Начните с процесса, а не с числа эндпоинтов.
Расскажите, какие системы и записи об аренде должны передаваться. Мы согласуем поддерживаемый объём, правила доступа и поток событий до запуска.
Держите поддерживаемые записи согласованными
Читайте одобренные записи арендного процесса, не открывая доступ к остальному рабочему пространству.
Семейства данных в текущем контракте
- Deals
- Properties
- Contacts
Реагируйте на важные изменения
Используйте подписанные вебхуки для поддерживаемых изменений сделок, платежей, документов, сторон, задач и комплаенса.
Семейства событий
- compliance
- deal
- document
- party
- payment
- task
Управляйте каждым ключом
Ограничьте ключ правами, списком эндпоинтов и, при необходимости, списком IP-адресов, а затем отзовите его или задайте срок действия.
Видьте, что произошло
Смотрите журнал вызовов API и историю доставки вебхуков, когда наблюдаете за интеграцией или разбираете сбой.
Как выдаётся доступ к интеграции на Enterprise
- 1
Согласуйте поддерживаемый объём
Расскажите, какие системы, записи и действия нужны интеграции. Мы подтвердим, что входит в одобренный внешний контракт.
- 2
Создайте ограниченный ключ компании
Администратор агентства создаёт ключ компании ТОЛЬКО НА ЧТЕНИЕ — с разрешёнными эндпоинтами, сроком действия и, при необходимости, списком IP-адресов.
- 3
Подключитесь и наблюдайте
Подписывайте каждый запрос API-ключом, проверяйте подписи вебхуков и следите за подключением по доступным журналам.
ГРАНИЦА ПОД КОНТРОЛЕМ
Каждой интеграции — только тот доступ, который ей нужен.
Изоляция по компании, доступ только на чтение, список разрешённых эндпоинтов, срок действия и необязательное ограничение по IP удерживают интеграцию внутри согласованных границ.
- В границах компании
- Доступ только на чтение
- Список эндпоинтов
- Ограничение по IP при необходимости
- Срок действия и отзыв
API — для записей. Вебхуки — для изменений.
Внешний API
Читайте поддерживаемые записи, открытые для вашей интеграции. Аутентификация — по ключу компании поверх HTTPS.
Подписанные вебхуки
Получайте поддерживаемые изменения без опроса. В каждой доставке есть идентификатор события, отметка времени и подпись HMAC-SHA256 для проверки.
История доставки и повторы помогают вашей команде разобрать неудавшиеся вызовы вебхуков.
Разрабатывайте по одобренному контракту интеграции.
При запуске ваша техническая команда получает согласованный состав ресурсов и событий, требования к аутентификации, поведение при ошибках, ограничения и правила проверки подписи вебхуков для этой интеграции.
Одобренный объём API
Вы видите только ресурсы и методы, подтверждённые для интеграции вашего агентства.
Аутентификация и ограничения
Вы получаете требования к ключу компании, права, поведение при ошибках и ограничения, действующие при запуске.
Проверка вебхуков
Настройте одобренный адрес приёма, проверяйте подписанные полезные нагрузки и разберитесь в правилах доставки и повторов.
Частые вопросы
- Входит ли доступ к API в планы с самостоятельным подключением?
- API-ключи и вебхуки — возможности плана Enterprise. Напишите в отдел продаж, какие системы и процессы вам нужны, чтобы согласовать поддерживаемый объём до запуска.
- Как интеграция проходит аутентификацию?
- Администратор агентства создаёт API-ключ в границах компании. Интеграция передаёт этот ключ в описанном заголовке HTTPS-запроса; ключ не обменивается на пользовательский JWT.
- Можно ли ограничить, к чему имеет доступ API-ключ?
- Да. Ключ ограничивается правами, списком разрешённых эндпоинтов, сроком действия и, при необходимости, списком IP-адресов, а затем отзывается, когда больше не нужен.
- Какие записи можно подключить?
- Доступные ресурсы зависят от внешнего контракта, согласованного для вашего запуска. В технической передаче перечислены только ресурсы и методы, одобренные для интеграции вашего агентства.
- Как защищены вызовы вебхуков?
- TenancyDesk отправляет поддерживаемые события на HTTPS-адреса с подписью HMAC-SHA256 и отметкой времени. Ваша интеграция проверяет подпись до обработки полезной нагрузки.
- Заменяет ли API импорт из Property Finder или Bayut?
- Нет. Property Finder работает по API-учётным данным вашего агентства, а Bayut / dubizzle — через импорт файла Excel из Profolio. API уровня Enterprise предназначен для одобренных подключений к вашим внутренним системам. Способ подключения по каждой площадке описан на странице интеграций.
- Можно ли протестировать API во время обычного бесплатного периода?
- 14-дневный период даёт возможности продукта уровня Professional. API-ключи и вебхуки согласуются отдельно с отделом продаж Enterprise.
Спланируйте интеграцию вокруг вашего реального процесса.
Расскажите, какие системы и записи должны передаваться. Мы согласуем поддерживаемый объём, средства контроля и порядок запуска.