Saltar al contenido principal
Todos los endpoints de la Scribe API requieren autenticación mediante una API key enviada como token Bearer en el encabezado Authorization.

Tipos de clave

Al crear una cuenta de médico se devuelven dos API keys:
  • Clave secreta (sk_…) — tu credencial del lado del servidor. Úsala como token Authorization: Bearer en todas las solicitudes de esta documentación. Mantenla en tu backend; nunca la expongas en un navegador.
  • Clave publicable (pk_…) — una credencial de navegador para el grabador embebible de Telepatia. Es solo de intercambio: el embed la canjea por un token de sesión de corta duración que conserva el acceso de lectura y escritura de tu 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, “API key” en esta documentación se refiere a tu clave secreta.

Obtener tu API key

Contacta a tu gerente de cuenta de Telepatia para obtener una API key para tu institución.

Realizar solicitudes autenticadas

Incluye la API key en cada solicitud:
Consulta la descripción general para conocer la URL base.

Vencimiento de la API key

Las API keys vencen. Las claves institucionales se emiten con una vigencia (por defecto, 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, regenera la clave de la cuenta y actualiza tu integración con el nuevo valor.

Respuestas de error

Ejemplo: API key ausente

Ejemplo: API key inválida

Ejemplo: clave publicable usada directamente

Una clave publicable (pk_) no puede llamar directamente a la API: primero canjéala por un token de sesión o usa tu clave secreta.