Desarrolladores · API de partners

API de partners de Ratatui

Acceso por invitación para datos de péptidos y GLP-1 con consentimiento del paciente. Usa Ratatui con Keragon para mover resúmenes, dosis, peso, síntomas y cambios de consentimiento a flujos de salud.

Solicitar acceso Leer guía rápida

URL base: https://api.ratatui.ai/v1

Guía rápida

Consulta datos con consentimiento usando una clave por invitación.

Las claves de la API de partners de Ratatui están limitadas a una clínica o profesional aprobado y solo a acciones específicas. Usa datos falsos hasta completar acceso de producción y revisión de BAA/seguridad.

Solicitud · resumen de paciente

curl "https://api.ratatui.ai/v1/patients/summary?external_system=demo_ehr&external_patient_id=ehr_demo_456" \
  -H "Authorization: Bearer ratatui_test_REDACTED"

Respuesta · datos falsos

{
  "ok": true,
  "summary": {
    "patient_id": "pat_demo_123",
    "consent_level": "limited",
    "shared_features": ["weight", "doses", "symptoms"],
    "latest_weight": { "value": 182, "unit": "lb" },
    "last_dose": {
      "medication": "Demo peptide",
      "amount": 5,
      "unit": "mg"
    }
  }
}

Recursos

Endpoints para sincronizar con EHR y CRM.

GET/patients/summaryPatient summary by Ratatui ID or external link

GET/dosesDose history

GET/symptomsSymptom history

GET/weightsWeight history

GET/consentConsent and shared-feature status

POST/patients/linkExternal patient ID link

GET/patients/external-linkExternal link lookup

POST/webhooksWebhook subscription

POST/webhooks/revokeWebhook revocation

Webhooks

Inicia flujos cuando ocurren eventos clínicos.

Ratatui envía webhooks HTTPS firmados a Keragon cuando ocurren eventos suscritos. Verifica la firma HMAC antes de confiar en el contenido.

dose.loggedsymptom.loggedweight.loggedsevere_symptom.alertpatient.consent.updated

Webhook signature

const signedPayload = `${timestamp}.${rawBody}`;
const expected = hmacSha256(webhookSigningSecret, signedPayload);
if (expected !== headerSignature) {
  throw new Error("Invalid Ratatui webhook signature");
}

Configuración admin

Crea, rota y revoca claves sin guardar secretos en texto plano.

Los admins aprobados de clínica o profesional manejan claves con endpoints protegidos. La clave se muestra una sola vez al crearla o rotarla; Ratatui guarda solo un hash. Las claves de producción requieren BAA de clínica firmado, modo HIPAA y evidencia firmada del BAA de Keragon.

Crear claveEmite un secreto ratatui_test_ o ratatui_live_ de una sola vez para una integración limitada.

Rotar claveReemplaza el secreto inmediatamente si cambia un proveedor, empleado o sistema.

Revocar claveDesactiva futuras llamadas y conserva el historial de auditoría.

Registrar BAA de KeragonBloquea llamadas de producción hasta guardar evidencia firmada.

Admin endpoints

GET  /api/admin/partner/v1/keys
POST /api/admin/partner/v1/keys
POST /api/admin/partner/v1/keys/rotate
POST /api/admin/partner/v1/keys/revoke
GET  /api/admin/partner/v1/compliance/keragon
POST /api/admin/partner/v1/compliance/keragon

Seguridad

Diseñado para integraciones de salud cautelosas.

El acceso es por invitación. Documentación pública no significa claves públicas.

Cada integración real debe usar IDs externos explícitos de paciente, no adivinar por nombre o fecha de nacimiento.

Las claves se limitan por clínica o profesional, ambiente, acción permitida, expiración y revocación.

Las llamadas de producción se bloquean sin BAA de clínica, modo HIPAA y evidencia firmada del BAA de Keragon.

Las solicitudes de escritura requieren Idempotency-Key para que los reintentos no dupliquen trabajo.

Los webhooks se firman con HMAC e incluyen IDs de evento y timestamps.

Ratatui usa BAA y es conforme con HIPAA para clientes de producción aprobados; no reclama certificación HIPAA gubernamental.

Keragon

Conecta con los sistemas que las clínicas ya usan.

La primera versión del conector es Keragon-first: Ratatui publica eventos y acciones de lectura, y Keragon los mapea a EHR, CRM, agenda, mensajería y operaciones.

Leer guia de Keragon