Перейти к содержимому
14 дней бесплатно, без карты9 языков176 типов бизнеса · 50 приложений
RU· USD
Попробовать живое демоПопробовать бесплатно

Интеграции и REST API: как это работает

Раздел интеграций и API позволяет другим программам работать с вашими данными. API-ключ даёт внешней системе право читать клиентов, лиды, коммерческие предложения, счета, заказы и товары и создавать некоторые из них, а вебхуки сообщают внешней системе о событии в ту же секунду, когда оно происходит. Так подключают бухгалтерские программы, сервисы автоматизации или собственное приложение.

Урок 2 из 9 · Как это работает

  • около 3 мин
  • System → Integrations → Integrations & API

Как это работает

  1. Вверху страницы «System → Integrations → Integrations & API» показаны четыре показателя: «Active keys», «Endpoints», «Delivered (7 d)» и «Failed». Ниже расположены панели «API keys», «Webhook endpoints» и «Event catalog».

  2. Нажмите «Create key», дайте ключу название, по которому понятно, где он используется, отметьте области доступа и при желании укажите срок действия. Область доступа — это право читать или записывать записи одного вида. Право записи включает право чтения.

  3. Новый ключ показывается один раз в блоке «Your new API key». Скопируйте его сразу: система хранит только его отпечаток, поэтому повторно показать ключ невозможно.

  4. Внешняя система передаёт ключ с каждым запросом. Она может получать списки и читать клиентов, лиды, коммерческие предложения, счета, заказы и товары, а также создавать клиентов, лиды, черновики предложений и черновики счетов.

  5. Лид, созданный через API, запускает те же сообщения, что и форма на сайте. Предложения и счета, созданные через API, всегда сохраняются как черновики, а налог рассчитывается так же, как в редакторе администратора. API никогда не отправляет их и не отмечает оплаченными.

  6. В строке каждого ключа видны его области доступа, кто его создал, число запросов и время последнего использования, а также метка «Active», «Expired» или «Revoked». Кнопка «Revoke» немедленно отключает ключ.

  7. «API docs» открывает полный справочник для разработчика, а «Delivery log» — список отправок вебхуков.

Где это найти

Настройки, которые на это влияют

Чек-лист

Прежде чем идти дальше, проверьте, что вы умеете:

  • Открыть System → Integrations → Integrations & API
  • Вверху страницы System → Integrations → Integrations & API показаны четыре показателя: Active keys,…
  • Нажмите Create key, дайте ключу название, по которому понятно, где он используется, отметьте области доступа…
  • Новый ключ показывается один раз в блоке Your new API key.
  • Внешняя система передаёт ключ с каждым запросом.

Советы и частые ошибки

  • Потеряли ключ? Восстановить его нельзя. Отзовите старый ключ и создайте новый.
  • Если запрос отклонён из-за отсутствующей области доступа, значит, ключ создан без этого права. Создайте новый ключ с отмеченной областью.
  • Ключ может сделать 300 запросов подряд, а затем 5 запросов в секунду. Система, которая обращается чаще, получает просьбу подождать, а повторные отказы для одного адреса могут привести к временной блокировке.
  • Обращайтесь с ключом как с паролем. Выдайте каждой подключённой системе собственный ключ, чтобы можно было отозвать один, не останавливая остальные.