Перейти к основному содержимому

Соглашения

Несколько правил действуют во всём API. Освойте их один раз.

Базовый URL

РегионБазовый URL
По умолчаниюhttps://api.sance.ai
Россияhttps://api.ru.sance.ai

Все эндпоинты находятся под /v1 — например, https://api.ru.sance.ai/v1/leads. Используйте хост, соответствующий вашему региону; пути одинаковы.

Привязка к продукту

Большинство эндпоинтов работают в рамках продукта (рабочего пространства) и требуют product_id (в query-параметре или в теле запроса). API проверяет, что у вашего аккаунта есть доступ к этому продукту; если нет — вы получите 403/404. Чтобы найти id, запросите список продуктов:

curl -s https://api.ru.sance.ai/v1/products/ -H "Authorization: Bearer $TOKEN"

Пагинация

Эндпоинты-списки принимают page (по умолчанию 1) и limit и возвращают постраничную обёртку:

{ "items": [ ... ], "page": 1, "limit": 50, "total": 220, "pages": 5 }

Ошибки

Ошибки используют стандартные HTTP-коды с телом JSON { "detail": "..." }:

КодЗначение
400Некорректный запрос (неверные данные или сочетание)
401 / 403Нет/неверный токен либо нет доступа к ресурсу
404Не найдено
409Конфликт (например, дубликат)
422Ошибка валидации

Время

Все метки времени — UTC, ISO 8601 (например, 2026-06-08T10:00:00Z).

Дальше

Первый запрос.