Справочник API для разработчиков
Подключите собственное приложение к рабочему пространству: REST API, его ключи и области действия, ошибки, ограничения частоты и вебхуки.
Где найти
⚙️ Настройки › Справочник API · Главная страница › Ресурсы › Справочник API
Открыть этот экран
Шаги
- Откройте “Справочник API” на боковой панели или “Справочник API” в меню “Ресурсы” на главной странице.
- Начните с раздела “С чего начать”: “Базовый URL и соглашения”, “Аутентификация” и “Области действия”.
- Ищите “Конечные точки” по группам; для каждой показаны параметры, тело запроса, ответ и ошибки с примерами.
- Перед запуском в работу прочитайте “Ошибки и коды состояния”, “Ограничения частоты” и “Вебхуки (исходящие)”. “OpenAPI JSON” скачивает всю спецификацию.
Устранение неполадок
Как получить ключ API?
Ключи для вашего рабочего пространства выпускаются по запросу; в приложении их пока создать нельзя. Ключи рабочего пространства перечислены на странице разработчика в разделе ИИ, где те, кто управляет рабочим пространством, также могут добавлять и проверять точки приёма вебхуков.
Советы
- Вызывайте API только со своего сервера. Никогда не размещайте ключ на веб-странице или в мобильном приложении.
Полезно знать
- Справочник API можно читать без входа.
Связанные инструкции
- Как найти конечную точку и скопировать пример? Ищите по справочнику API, переходите к конечной точке и копируйте её пример или ссылку.
- Как читать частые вопросы (Документация)? Читайте короткие ответы о том, что продукт умеет сегодня: начало работы, языки и голоса, тестовые звонки, телефонные номера, тарифы и учётная запись.
- Возможности Полный каталог возможностей колл-центра, где каждая честно помечена как выпущенная или запланированная.