Volver al proyecto · Índice de documentación
Los comandos se ejecutan desde la raíz del repositorio.
./scripts/rako-api # uvicorn en 127.0.0.1:8765La documentación interactiva vive en http://127.0.0.1:8765/docs (OpenAPI).
Para exportar el contrato completo (por ejemplo, para generar el cliente
Flutter):
.venv/bin/python scripts/export_openapi.pyGrupos de endpoints (≈50 rutas, detalle en /docs):
| Grupo | Qué cubre |
|---|---|
core |
/health, /status, /pairing/info (datos públicos de emparejamiento) |
setup |
primer encendido: /setup, /setup/flow, /setup/first-run, WiFi, hotspot, QR |
user |
perfil, consentimiento, canales, memoria editable, export, borrado total |
productividad |
tareas, /focus/start, progreso diario/semanal, /coach/plan |
factory |
reporte, provisioning-plan, install-plan (dry-run por defecto), checks de hardware |
device |
identidad de placa, heartbeat, reset de usuario, OTA (/update/*) |
whatsapp |
envíos internos, plantillas, webhook de Meta (verificación + firma) |
observabilidad |
/observability, /security/audit, /support/bundle, /fleet/snapshot |
Seguridad de la API:
- Escucha solo en
127.0.0.1:8765por defecto (RAKO_API_HOST/RAKO_API_PORT). - Con
RAKO_API_TOKENdefinido, todo excepto/healthy/pairing/infoexigeAuthorization: Bearer <token>; fuera dedevel token es obligatorio. - Fuera de
dev, el arranque aborta si la base SQLite no está cifrada (gate de SQLCipher en el lifespan). POST /user/delete-allejecuta borrado total real: config de producto, tareas, interacciones, estados de ánimo, logros y journal de crisis (Database.purge_all_user_data()), con efecto inmediato.- La contraseña WiFi nunca se persiste;
nmclisolo se ejecuta conapply=true+RAKO_WIFI_APPLY_ENABLED=1(ídem hotspot conRAKO_SETUP_HOTSPOT_ENABLED=1).
Canal de producto completo sobre WhatsApp Business Cloud API
(src/channels/whatsapp/): check-ins, menú de acciones, reportes de
progreso con conteos (nunca títulos de tareas), memoria editable
(recuerda que…, qué sabes de mí, olvida…), configuración, pausa de
mensajes, export y borrado con confirmación.
Reglas de privacidad del canal (detalle en CLAUDE.md §4.1):
- Solo memorias
sensitivity=normalsalen por WhatsApp; de las sensibles solo se informa la cantidad. - El remitente debe coincidir con el número emparejado antes de exponer datos o ejecutar borrado. Un número no emparejado solo puede recibir el protocolo de crisis o una respuesta genérica.
- El webhook de Meta se valida por firma HMAC (
X-Hub-Signature-256) antes de procesar cualquier payload; fuera dedev,WHATSAPP_CLOUD_APP_SECRETes obligatorio. - La detección de crisis corre antes que cualquier otra rama y usa el mismo detector curado que la voz.
Configuración (sin credenciales usa un cliente en memoria para desarrollo):
WHATSAPP_CLIENT=cloud
WHATSAPP_CLOUD_ACCESS_TOKEN=...
WHATSAPP_CLOUD_PHONE_NUMBER_ID=...
WHATSAPP_CLOUD_VERIFY_TOKEN=...
WHATSAPP_CLOUD_APP_SECRET=...El scheduler decide si corresponde un check-in proactivo respetando consentimiento, horario silencioso, intervalo mínimo, actividad reciente y crisis recientes (no compite con el protocolo de seguridad):
./scripts/rako.sh smart-checkin --dry-run
./scripts/rako.sh smart-checkinRequiere whatsapp_enabled=true, proactive_messages_enabled=true y
whatsapp_number configurado.