Перейти к основному содержимому
Разработчикам

API-ключи

Создайте ключ для своей программы и передавайте его с каждым запросом к HANC API.

API-ключ позволяет вашей собственной программе работать с HANC API: получать список звонков, создавать агентов, покупать номера, читать вашу CRM. Ключ действует с вашими правами — что вы можете сделать в кабинете, то он может сделать через API.

Создание ключа​

  1. Откройте ключи

    Интеграции → вкладка Разработчикам → API-ключи воркспейса.

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

    Нажмите Создать API-токен. Ключ появится в списке; кнопка показа откроет его, оттуда его и скопируйте.

  • До 3 ключей на рабочее пространство.
  • У ключей нет названия и отдельных прав: ключ получает ваш доступ во всех рабочих пространствах, где вы состоите.
  • Ключ можно снова показать из списка — поэтому относитесь к списку как к секретным данным.

Как использовать​

Передавайте ключ в заголовке x-api-key, без префикса Bearer:

curl "https://api.hanc.ai/v1/agent/list" \
-H "x-api-key: YOUR_API_KEY"

Все эндпоинты описаны в Справочнике API.

Безопасность​

  • Храните ключи на своём сервере — никогда в браузере, в мобильном приложении или в чём-либо, что может открыть пользователь.
  • Никогда не добавляйте их в систему контроля версий.
  • Время от времени меняйте их; сразу удаляйте ключ, если кто-то ушёл из команды или ключ мог утечь.