Saltar al contenido principal

API specs

Las APIs de Moveat son APIs internas de producto. No están diseñadas hoy como superficie pública para terceros.
Los schemas exactos viven en Swagger de Platform. Esta página explica ownership y comportamiento a nivel alto.

Superficies

SuperficieBaseConsumidorAuthPropósito
Platform public APIhttps://api.mov-eat.app/v1Web clientCookie HTTP-onlyAcciones de usuario.
Platform internal APIhttps://api.mov-eat.app/internal/v1AgentInternal service tokenOperaciones service-to-service.
Platform healthhttps://api.mov-eat.app/healthzInfraNingunaHealth checks.
Agent webhook/APIhttps://agent.mov-eat.appMeta/WhatsApp e infraFirma Meta / verify tokenWebhooks y health.
Swagger públicohttps://api.mov-eat.app/docsIngenieríaBasic auth docsInspección APIs públicas.
Swagger Agenthttps://api.mov-eat.app/agent-docsIngenieríaBasic auth docsInspección APIs internas.

Platform public API

Soporta web flows: auth, /me, onboarding, channels, coaching, meals, weight y workouts. Reglas:
  • El user ID sale de la sesión, no del body.
  • Platform hace conversiones de unidades.
  • Las respuestas deben ser útiles para el consumidor que las renderiza.
  • Los errores deben tener contexto y correlation IDs.

Platform internal API para Agent

Permite que Agent delegue acciones sin tocar la DB. Operaciones principales:
  • Resolver usuario por canal.
  • Obtener contexto de usuario.
  • Registrar meal entry.
  • Obtener nutrición de hoy.
  • Registrar peso.
  • Registrar workout.

Agent API

Agent expone principalmente endpoints para webhooks y health.

Estrategia OpenAPI

Siguiente mejora recomendada:
  1. Mantener Swagger en Platform como contrato vivo.
  2. Exportar OpenAPI público a openapi/platform-public.json.
  3. Exportar OpenAPI interno a openapi/platform-agent.json.
  4. Referenciar esos specs en docs.json para generar API Reference en Mintlify.