Доступ к API — получение ключа и возможности
У Teamopipe есть REST API, который позволяет программно читать и записывать данные — создавать сделки из внешних источников, синхронизировать контакты с другими инструментами, экспортировать данные для отчётов или создавать собственные автоматизации. Здесь описано, как получить API-ключ и что API может.
Получение API-ключа
- Откройте панель Teamopipe в Gmail.
- Перейдите в Настройки → Настройки рабочего пространства.
- Нажмите API-ключи.
- Нажмите Сгенерировать ключ.
- Скопируйте ключ и сохраните его в безопасном месте — он показывается только один раз.
Примечание: управление API-ключами доступно только администраторам. Если вы не видите эту опцию в Настройках рабочего пространства, вы, вероятно, участник, а не администратор — обратитесь к администратору вашего рабочего пространства.
Использование API-ключа
Передавайте ключ в заголовке Authorization каждого запроса: Authorization: Bearer YOUR_API_KEY. Базовый URL — api.teamopipe.com/api/v2. Полная интерактивная документация — включая схемы запросов/ответов и тестирование прямо в браузере — находится на api.teamopipe.com/api/v2/docs.
Что охватывает API
- Сделки — создание, чтение, обновление, удаление; массовое создание, перемещение между этапами, обновление пользовательских полей, журналы активности, экспорт в CSV. Полезно для синхронизации лидов с веб-формы или передачи данных о закрытых сделках в инструмент отчётности.
- Контакты — полный набор действий, массовое создание и создание-или-обновление по e-mail — удобно для поддержания синхронизации Teamopipe с внешним списком. Поддерживается экспорт в CSV и записи активности.
- Организации — полный набор действий с массовыми операциями и экспортом в CSV. Полезно для синхронизации данных о компаниях из CRM, ERP или базы данных.
- Воронки и этапы — чтение воронок и этапов; создание, переупорядочивание и переименование этапов программно.
- Пользовательские поля — создание и управление полями (в API они называются динамическими полями), чтение определений и вариантов, получение или установка значений для сделок, контактов или организаций.
- Задачи — полный набор действий с массовыми операциями и экспортом в CSV. Создавайте задачи на следующие действия автоматически от внешних триггеров.
- Команды и участники — чтение данных команды и списков участников, управление приглашениями.
Частые случаи использования
- Веб-форма → сделка: автоматически создавайте сделку, когда кто-то заполняет контактную форму на вашем сайте
- Синхронизируйте контакты с внешним списком рассылки или базой данных, используя создание-или-обновление по e-mail
- Подтягивайте данные сделок и воронки в Google Таблицы или BI-инструмент для отчётов
- Создавайте задачи на следующие действия по внешним триггерам — подписанный договор, полученный платёж
Отзыв API-ключа
Настройки → Настройки рабочего пространства → API-ключи → удалите ключ. Интеграции, использующие его, немедленно теряют доступ; вы можете создать новый ключ в любой момент.
Если у вас есть вопросы об API, используйте чат в правом нижнем углу или форму связи на teamopipe.com/en/contact — обычно отвечаем в течение 4 часов в рабочие дни.