Skip to main content
Todos los endpoints de la Scribe API requieren autenticación mediante una clave API enviada como token Bearer en el encabezado Authorization.

Tipos de clave

Al crear una cuenta de médico se devuelven dos claves API:
  • Clave secreta (sk_…) — su credencial del lado del servidor. Úsela como token Authorization: Bearer en todas las solicitudes de esta documentación. Manténgala en su backend; nunca la exponga en un navegador.
  • Clave publicable (pk_…) — una credencial de navegador para el grabador embebible de Telepatia. Es solo de intercambio: el embed la intercambia por un token de sesión de corta duración que lleva el acceso de lectura y escritura de su cuenta. Una clave pk_ no puede llamar directamente a la Scribe API — presentarla como token Bearer en cualquier endpoint devuelve 403 permission_denied.
Salvo que se indique lo contrario, “clave API” en esta documentación se refiere a su clave secreta.

Obtener su clave API

Contacte a su gerente de cuenta de Telepatia para obtener una clave API para su institución.

Realizar solicitudes autenticadas

Incluya la clave API en cada solicitud:
Consulte la descripción general para la URL base.

Vencimiento de la clave API

Las claves API vencen. Las claves institucionales se generan con una vigencia (predeterminada: 365 días, configurable mediante apiKeyConfig.validForDays al crear una cuenta). Una vez que una clave supera su vencimiento, las solicitudes fallan con 401 y la misma respuesta “Invalid API key.” que una clave revocada o desconocida. Para restaurar el acceso, regenere la clave de la cuenta y actualice su integración con el nuevo valor.

Respuestas de error

Ejemplo: Clave API faltante

Ejemplo: Clave API inválida

Ejemplo: Clave publicable usada directamente

Una clave publicable (pk_) no puede llamar directamente a la API — intercámbiela primero por un token de sesión, o use su clave secreta.