Быстрый старт

Первый запрос к API за пять минут.

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

Откройте в кабинете Настройки → API и MCP и нажмите «Создать ключ». Отметьте только те права, которые действительно нужны интеграции: чтение диалогов — это не право отвечать клиентам, а право отвечать — не право писать внутренние заметки.

Ключ показывается один раз. Скопируйте его сразу и положите туда, где вы храните пароли. Если потеряли — отзовите старый и создайте новый, это безопасно.

Ключ принадлежит проекту, а не сотруднику. Он продолжит работать, когда человек, создавший его, уйдёт из компании.

2. Проверьте ключ

curl -H "Authorization: Bearer $TYGY_API_KEY" https://api.tygy.ru/v1/me

В ответе — имя ключа, его права, ваш проект и лимиты:

{
  "key": { "id": "…", "name": "Синхронизация с CRM", "scopes": ["contacts:read"] },
  "company": { "id": "…", "name": "Акме", "slug": "acme", "brand": "Tygy" },
  "rate_limit": { "company_per_minute": 600, "key_per_minute": 300 },
  "api_version": "v1"
}

Этот же запрос стоит использовать как проверку связи в вашей интеграции.

3. Прочитайте данные

curl -H "Authorization: Bearer $TYGY_API_KEY" \
  "https://api.tygy.ru/v1/conversations?status=open&limit=20"

Списки возвращаются постранично, курсором:

{ "data": [ … ], "has_more": true, "next_cursor": "eyJrIjoi…" }

Передайте next_cursor в параметр starting_after, чтобы получить следующую страницу. Подробнее — в разделе Постраничная выдача.

4. Что дальше

• Аутентификация и права — как устроены ключи и области доступа.
• Вебхуки — получать события, а не опрашивать нас по таймеру.
• Ошибки — единый формат отказа и номер запроса для поддержки.
• Справочник методов — все методы с примерами.

Базовый адрес

Используйте адрес того бренда, под которым зарегистрирован ваш проект. Его подскажет поле company.brand в ответе /v1/me.