Skip to main content
La gestión de cuentas solo está disponible con una clave API institucional. Las claves API de nivel médico no tienen acceso a estos endpoints.
Las claves API institucionales pueden crear y recuperar cuentas de médicos dentro de su organización. Cada cuenta representa a un médico que puede usar el scribe de Telepatia a través de su integración. Crear una cuenta genera dos claves para esa cuenta — una clave secreta (sk_…) para las llamadas API del lado del servidor y una clave publicable (pk_…) para el embed de navegador (vea Tipos de clave). Puede rotar la clave secreta más adelante.

​
Crear una cuenta

POST /v1/institutional/accounts requiere email y doctorSpecialties. Opcionalmente, envíe apiKeyConfig.validForDays (1–365) para controlar cuánto tiempo permanece válida la clave API generada; omítalo para usar el valor predeterminado de 365 días (1 año).
Respuesta:
apiKey (secreta) y publishableApiKey (publicable) se devuelven solo una vez — guárdelas de forma segura. expiresAt es la marca de tiempo UTC en que las claves dejan de funcionar, y apiKeyExpiresInDays refleja la vigencia que se aplicó. Use la clave secreta para las llamadas API del lado del servidor; la clave publicable es para el embed de navegador y no puede llamar directamente a la API.
Guarde el id (o su internalCode) — puede usar cualquiera de los dos para recuperar la cuenta más adelante.

​
Recuperar una cuenta

Busque una cuenta por su id (acc_*) o por su propio internalCode.
Respuesta:

​
Regenerar una clave API

Rote la clave API de una cuenta con POST /v1/institutional/accounts/{account_id}/api-keys/regenerate, identificando la cuenta por su id (acc_*) o internalCode. Opcionalmente, envíe validForDays (1–365) para definir la vigencia de la nueva clave; omítalo para mantener el valor predeterminado de la cuenta.
Respuesta:
Regenerar revoca la clave anterior (tras un breve período de gracia) y devuelve la nueva apiKey sin cifrar una sola vez — actualice su integración antes de que termine el período de gracia. La regeneración está limitada a una por cuenta cada 2 minutos; excederla devuelve 429 rate_limit_exceeded. Consulte Manejo de errores.