Документация API (для разработчиков)

Если у вас своя CRM, нестандартный коннектор или вы пишете самостоятельную интеграцию — этот раздел для вас. Обычным пользователям достаточно сценариев «Из таблицы» или «Из AmoCRM».

Где взять адрес и ключ

В редакторе раздел Интеграции → внизу свёрнутый блок «Для разработчиков». Там два значения:

Адрес для обновлений — конкретная ссылка для вашего проекта, скопируйте из редактора
Ключ доступа — сгенерируется по кнопке. Хранится в зашифрованном виде на стороне платформы, в открытом виде вам показывается один раз (на момент генерации). Если потеряли — отзовите старый и сгенерируйте новый.

Назначение

API служит только для обновления статусов участков из внешней системы (CRM или собственный коннектор). Через API нельзя:

Менять цены, площади, описания участков (это контент — приходит из таблицы)
Создавать или удалять участки (геометрия настраивается в редакторе)
Публиковать или снимать с публикации проект
Управлять подпиской / тарифом / биллингом

Содержимое и структура — через таблицу или редактор.

Формат запроса

Тело — JSON со списком обновлений. Пример:

{
  "updates": [
    { "plotNumber": "15", "status": "reserved" },
    { "plotNumber": "16А", "status": "sold" },
    { "plotNumber": "А-12", "status": "available" }
  ]
}

Поля:

Поле	Тип	Обязательно	Что значит
`plotNumber`	строка	Да	Номер участка как в редакторе. Регистр не важен.
`status`	строка	Да	Один из: `available`, `reserved`, `sold`, `with_house`, `promotion`, `unavailable`, `draft`

Ротация ключа доступа

Ключ можно отозвать в любой момент через UI редактора → «Отозвать». После этого все запросы со старым ключом будут отвергнуты. При компрометации (ключ попал в публичный репозиторий, утёк через лог) — отзывайте сразу и сгенерируйте новый.

При генерации нового ключа старый перестаёт работать — это намеренно, чтобы скомпрометированный ключ можно было быстро аннулировать.

Лимиты и точные параметры

Точные параметры запросов (лимиты частоты, максимальный размер тела, формат заголовка авторизации) уточняйте у поддержки до интеграции — они зависят от тарифа и могут меняться. Напишите на адрес поддержки SmartGenPlan, мы пришлём актуальные значения.

Поддержка

Вопросы про API: писать через личный кабинет или контактные данные на главной smartgenplan.ru. В сообщении укажите ID проекта (можно найти в адресной строке редактора) и пример запроса который не работает.