Автоматизация и интеграции

Основы доступа к API: как настраиваются интеграции Enterprise

10 мин чтения

На Enterprise ваш Admin настраивает Webhooks в Settings; внешний API только для чтения выдаётся на каждую интеграцию после проверки объёма нашей командой.

продвинутый10 мин чтения

На тарифе Enterprise TenancyDesk предлагает два способа подключить ваши системы, и настраиваются они по-разному.

Webhooks: настраивает ваш Admin

Webhooks сообщают вашей системе, когда в TenancyDesk что-то меняется. Ваш Admin добавляет их в Settings → Webhooks — отдельного одобрения не нужно. Каждая доставка подписана, и ваша система проверяет подпись секретом, который показывается при создании Webhook.

Внешний API: выдаётся на каждую интеграцию

Внешний API позволяет вашей системе читать записи агентства; он только для чтения. Тариф даёт право его запросить; сам он не включается.

  1. В Settings → API Keys опишите, какие системы подключаются и какие записи им нужны, и нажмите Send request.
  2. Наша команда проверяет объём и отвечает.
  3. Когда доступ выдан, ваш Admin создаёт там ключ. Ключ показывается один раз — сохраните его надёжно. Он видит только записи вашей компании, и его можно ограничить определёнными эндпоинтами и IP-адресами и задать срок действия.

С чего начать

Прочитайте страницу Developer API and Webhooks, затем свяжитесь с нами и опишите нужный процесс.

Пошагово

  1. 1

    Webhooks: добавьте в Settings

    Ваш Admin добавляет Webhooks в Settings → Webhooks и сохраняет секрет подписи, показанный при создании.

  2. 2

    API: отправьте запрос

    В Settings → API Keys опишите, какие системы подключаются и какие записи им нужны, и нажмите Send request.

  3. 3

    API: дождитесь проверки

    Наша команда проверяет объём и отвечает. Внешний API только для чтения.

  4. 4

    API: создайте ключ

    Когда доступ выдан, ваш Admin создаёт ключ; он показывается один раз и видит только записи вашей компании.

Было ли это руководство полезным?

Готовы применить на практике?

Начните бесплатный 14-дневный пробный период и примените полученные знания.

Начать бесплатный период