API-ключи
API-ключи — это Bearer-токены, предоставляющие программный доступ к REST API LeadHub. Используйте их для создания пользовательских интеграций, синхронизации данных с другими системами или автоматизации задач через код.
Создание API-ключа
- Перейдите в Интеграции → API-ключи.
- Нажмите Новый API-ключ.
- Заполните поля:
| Поле | Описание |
|---|---|
| Название | Описательное имя (например, «Интеграция с моим приложением», «Zapier») |
| Права доступа | Какие действия мо жет выполнять ключ (только чтение, чтение и запись) |
| Срок действия | Необязательная дата истечения; оставьте пустым для бессрочного ключа |
- Нажмите Сохранить.
- Скопируйте токен сразу — он отображается только один раз. Если вы его потеряете, потребуется его перегенерировать.
Использование API-ключа
Включайте ключ в качестве Bearer-токена в каждый API-запрос:
GET /api/leads HTTP/1.1
Host: yourdomain.com
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json
Конечные точки API
| Метод | Конечная точка | Описание |
|---|---|---|
GET | /api/leads | Список всех лидов (с пагинацией) |
GET | /api/leads/{id} | Получение одного лида |
POST | /api/leads | Создание нового лида |
PUT | /api/leads/{id} | Обновление лида |
DELETE | /api/leads/{id} | Удаление лида |
GET | /api/pipelines | Список воронок |
GET | /api/tags | Список тегов |
POST | /api/leads/{id}/tags | Добавление тегов к лиду |
Полная справочная документация API доступна в Swagger-документации LeadHub по адресу /api/documentation в вашей установке.
Отзыв ключа
Для отзыва API-ключа:
- Перейдите в Интеграции → API-ключи.
- Нажмите значок удаления в строке ключа и подтвердите.
Ключ немедленно аннулируется. Все запросы с его использованием получат ответ 401 Unauthorized.
Рекомендации по безопасности
- Никогда не добавляйте API-ключи в систему контроля версий (GitHub, Bitbucket и т.д.)
- Используйте ключи только для чтения, если требуется только чтение данных
- Устанавливайте сроки действия для ключей, используемых в временных интеграциях
- Немедленно отзывайте ключи при возможной утечке
- Используйте отдельный ключ для каждой интеграции, чтобы можно было отозвать конкретный