Обзор эндпоинтов

Обзор API-эндпоинтов

REST API myumbrella.ai организован вокруг ресурсов. Все эндпоинты используют JSON для тел запросов/ответов и стандартные HTTP-методы.

Базовый URL: https://api.myumbrella.ai/v1

Гарантийные планы

Метод	Эндпоинт	Описание
GET	/plans	Список всех планов
POST	/plans	Создать новый план
GET	/plans/:id	Получить детали плана
PUT	/plans/:id	Обновить план
DELETE	/plans/:id	Архивировать план

Пример: Создание плана

curl -X POST https://api.myumbrella.ai/v1/plans \
  -H "Authorization: Bearer mu_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "2-Year Protection",
    "coverage": ["mechanical", "accidental"],
    "duration_months": 24,
    "price_model": "percentage",
    "rate": 0.12
  }'

Претензии

Метод	Эндпоинт	Описание
GET	/claims	Список претензий (с фильтрацией)
POST	/claims	Подать новую претензию
GET	/claims/:id	Получить детали претензии
PATCH	/claims/:id	Обновить статус претензии
POST	/claims/:id/notes	Добавить примечание к претензии

Контракты

Метод	Эндпоинт	Описание
GET	/contracts	Список активных контрактов
GET	/contracts/:id	Получить детали контракта
POST	/contracts/:id/cancel	Отменить контракт

Аналитика

Метод	Эндпоинт	Описание
GET	/analytics/revenue	Сводка по выручке
GET	/analytics/claims	Метрики претензий
GET	/analytics/attach-rate	Коэффициент присоединения за период

Пагинация

Все эндпоинты списков поддерживают курсорную пагинацию:

GET /v1/plans?limit=25&starting_after=plan_xyz

Ответ включает булево значение has_more и метаданные пагинации.