Быстрый старт API #
Машинные маршруты HeySora отдаются с одного базового адреса:
https://api.heysora.ai
Семейства маршрутов: /api/v1 (канал приложения и интеграционный API), /channel/v1 (универсальный шлюз каналов) и /chat/v1 (веб-чат).
1. Получите ключи #
Ключи принадлежат подключению вашей организации. Войдите в рабочее пространство, откройте Разработчикам и создайте подключение. Портал покажет ключи этого подключения; храните их на сервере и никогда не кладите в мобильное приложение или веб-страницу. Начните с песочницы: это отдельная среда со своими ключами и без реальных клиентов.
2. Вызовите API #
Каждый запрос сервер-сервер содержит bearer-токен и подписывается. Форма запроса (заголовки подписи описаны в статье об аутентификации и здесь не повторяются):
curl -X POST "https://api.heysora.ai/api/v1/<маршрут>" \
-H "Authorization: Bearer <ВАШ_ТОКЕН>" \
-H "Content-Type: application/json" \
-d '{ ... }'
Схема подписи имеет версии и описана только в одном месте: статья Справки Аутентификация и подпись запросов в вашем рабочем пространстве (нужен вход). Лучше используйте официальные SDK или следуйте этой статье точно; не копируйте код подписи из сторонних источников.
3. Обработайте результат #
- Ответы - JSON. Ошибки содержат стабильный машиночитаемый код.
- Повторяйте только безопасные для повтора запросы и используйте ключи идемпотентности там, где API их предоставляет.
- Соблюдайте лимиты: при
429делайте паузу.
Дальше: аутентификация, вебхуки и полный справочник API в рабочем пространстве.