Saltar al contenido principal

​
Autenticación

Todos los endpoints de la API de Nevatal requieren autenticación a través de claves de API. Su clave de API identifica su clínica y determina el alcance de los datos a los que puede acceder.

​
Cómo obtener su clave de API

  1. Inicie sesión en su panel de Nevatal en app.nevatal.com
  2. Navegue a Configuración → Claves de API
  3. Haga clic en Crear Clave de API
  4. Seleccione los alcances (permisos) que necesita su integración
  5. Copie y almacene de forma segura la clave generada
Las claves de API se muestran solo una vez en el momento de la creación. Almacénelas de forma segura. Si pierde una clave, revóquela y cree una nueva.

​
Cómo usar su clave de API

Incluya la clave de API como un token Bearer en el encabezado Authorization de cada solicitud: 
curl -X GET https://api.nevatal.com/api/v1/patients 
  -H "Authorization: Bearer nvtl_su_clave_de_api_aqui" 
  -H "Content-Type: application/json"

​
Alcances (Scopes)

Las claves de API están limitadas a módulos específicos. Al crear una clave, usted selecciona a qué módulos puede acceder:
Alcance (Scope)LecturaEscrituraDescripción
patients✅✅Registros de pacientes y datos demográficos
appointments✅✅Agendamiento y gestión de citas
billing✅✅Facturas, pagos y notas de crédito
emr✅✅Historias clínicas, prescripciones, notas clínicas
clinical-procedures✅✅Catálogo y gestión de procedimientos clínicos
locations✅❌Información de las sedes de la clínica

​
Gestión de claves

​
Revocar una clave

curl -X DELETE https://api.nevatal.com/api/v1/api-keys/{keyId} 
  -H "Authorization: Bearer nvtl_clave_de_administrador"

​
Listar claves activas

curl -X GET https://api.nevatal.com/api/v1/api-keys 
  -H "Authorization: Bearer nvtl_clave_de_administrador"

​
Mejores prácticas de seguridad

Las claves de API solo deben usarse en la comunicación de servidor a servidor. Nunca las incluya en el código JavaScript de su frontend, en aplicaciones móviles o en repositorios públicos.
Solo otorgue los alcances que su integración realmente necesita. Una integración de facturación no necesita acceso al EMR.
Cree nuevas claves periódicamente y revoque las antiguas. Esto limita el impacto de una clave comprometida.
Almacene las claves de API en variables de entorno o en un gestor de secretos, nunca las escriba directamente en los archivos de código fuente.