Центр поддержкиИнтеграции

Для: Администраторы

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

Создайте управляющий ключ для API панели администратора или ключ-хаб для API портала, ограничьте его доступом только к вашим IP-адресам и скопируйте его один раз.

В этой статье8 разделов

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

  1. Открыть клавиши

    Перейдите на страницу Интеграция › Ключи и выберите НОВЫЙ.

  2. Назовите это

    Под Описание укажите, как будет использоваться этот элемент, например, для синхронизации данных.

  3. Ограничьте места его использования.

    Под Источник CIDR введите публичный IPv4-адрес, с которого осуществляются вызовы на вашу систему. Можно использовать как конкретный адрес, так и диапазон адресов, например 203.0.113.0/24. Вызовы из любых других мест не будут приняты. Хаб видит только IPv4-адреса, поэтому IPv6-адреса не принимаются.

    Если вы еще не знаете адрес, оставьте поле пустым. Это позволит указать любой адрес. После первого вызова вашего системы, Последний использованный IP-адрес будет показывать этот адрес. См. раздел Ограничение или отмена API-ключа.

  4. Выберите его тип

    Под элементом Домен выберите опцию Управление для работы с API административного панели, или опцию Хаб для работы с API портала. Эту опцию нельзя изменить позже.

  5. Включите его и добавьте.

    Активный начинается с этого значения. Оставьте его таким: неактивный ключ будет отклоняться при каждой вызове. Выберите Добавить ключ. Мерцающая надпись “Ключ добавлен” означает, что ключ был успешно добавлен.

  6. Скопируйте ключ

    Окно с символом Секретный ключ показывает этот ключ только один раз. Выберите кнопку “Копировать” – Скопировать в буфер обмена – и сохраните ключ в месте, куда будет иметь доступ разработчик: например, в хранилище паролей. Затем выберите кнопку Готово.

Что произойдет дальше?

Ключевые файлы отправляются одновременно и не теряют своей актуальности. Ваш разработчик отправляет их при каждом вызове функции. См. описание подробнее. Авторизуйте запросы API с помощью ключа.. Он служит как центр управления всеми процессами. Виртуальный помощникВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника., Так что то, что он публикует, является информацией о Виртуальном помощнике.

Последнее использование и Последний использованный IP-адрес показывают дату и адрес последней вызова. Чтобы отключить или удалить эту информацию, смотрите раздел Ограничение или отмена API-ключа.

Если что-то пойдёт не так

  • Достигается ключевой предельный уровень. У вашего хаба может быть по два ключа каждого типа. Удалите один из этих ключей, который вы больше не используете.
  • Согласно данным CIDR-категории, адресный блок является некорректным. Примеры корректных адресов: 203.0.113.10 или 203.0.113.0/24. Проверьте адрес: четыре числа от 0 до 255, разделенные точками. Для указания диапазона используйте символ slash и число до 32.
  • Согласно информации из CIDR-категории, необходимо использовать адрес IPv4 или диапазон адресов IPv4. Например, можно использовать адрес 203.0.113.10. Доступ к API возможен только через IPv4. Вы ввели адрес IPv6. Вместо этого используйте адрес IPv4, предоставляемый вашим системой.
  • Вы потеряли ключи. Нельзя повторно создать этот объект. Сначала создайте новый объект, перенесите свою систему в него, а затем удалите старый объект. Если у вас уже есть два таких объекта, сначала удалите старый объект. Ваша система не сможет связаться с центром управления, пока у нее нет нового ключа для связи с центром.

Статьи по теме

Аутентификация API-запросов с помощью ключа.Отправьте свой ключ в виде токена носителя в API панели администратора для управления ключом или в API портала для ключа хаба, ограничив его использование только вашими IP-адресами.ИнтеграцииОграничить использование или отозвать ключ API.Ограничьте использование ключа определенными IP-адресами, отключите или удалите его и посмотрите, когда он использовался в последний раз.Интеграции · 2 minРазберитесь, что может делать API.Узнайте, к чему могут иметь доступ ключ управления и ключ концентратора, почему каждый ключ действует как виртуальный помощник и где находится полный технический паспорт.Интеграции