Visão Geral dos Endpoints

Visão Geral dos Endpoints da API

A API REST do myumbrella.ai é organizada em torno de recursos. Todos os endpoints usam corpos de requisição/resposta em JSON e métodos HTTP padrão.

URL Base: https://api.myumbrella.ai/v1

Planos de Garantia

Método	Endpoint	Descrição
GET	/plans	Listar todos os planos
POST	/plans	Criar um novo plano
GET	/plans/:id	Obter detalhes do plano
PUT	/plans/:id	Atualizar um plano
DELETE	/plans/:id	Arquivar um plano

Exemplo: Criar um Plano

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
  }'

Reclamações

Método	Endpoint	Descrição
GET	/claims	Listar reclamações (filtrável)
POST	/claims	Registrar uma nova reclamação
GET	/claims/:id	Obter detalhes da reclamação
PATCH	/claims/:id	Atualizar status da reclamação
POST	/claims/:id/notes	Adicionar uma nota a uma reclamação

Contratos

Método	Endpoint	Descrição
GET	/contracts	Listar contratos ativos
GET	/contracts/:id	Obter detalhes do contrato
POST	/contracts/:id/cancel	Cancelar um contrato

Análises

Método	Endpoint	Descrição
GET	/analytics/revenue	Resumo de receita
GET	/analytics/claims	Métricas de reclamações
GET	/analytics/attach-rate	Taxa de adesão ao longo do tempo

Paginação

Todos os endpoints de listagem suportam paginação baseada em cursor:

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

A resposta inclui um booleano has_more e metadados de paginação.