Saltar al contenido principal

​
Guía de Inicio Rápido

Póngase en marcha con la API de Nevatal en tres sencillos pasos.

​
Prerrequisitos

  • Una cuenta de Nevatal con una clínica activa
  • Una clave de API (cree una aquí)

​
Paso 1: Verifique su conexión

Pruebe que su clave de API funciona consultando el endpoint de salud: 
curl -X GET https://api.nevatal.com/health
Respuesta esperada: 
{
  "status": "ok"
}

​
Paso 2: Liste sus pacientes

Obtenga la primera página de pacientes de su clínica: 
curl -X GET https://api.nevatal.com/api/v1/patients 
  -H "Authorization: Bearer nvtl_su_clave_de_api" 
  -H "Content-Type: application/json"
Respuesta: 
{
  "data": [
    {
      "id": "pat_abc123",
      "firstName": "María",
      "lastName": "García",
      "email": "maria@example.com",
      "phone": "+573001234567",
      "documentType": "CC",
      "documentNumber": "1234567890",
      "createdAt": "2025-03-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 142
  }
}

​
Paso 3: Cree una cita

Agende una cita para un paciente: 
curl -X POST https://api.nevatal.com/api/v1/appointments 
  -H "Authorization: Bearer nvtl_su_clave_de_api" 
  -H "Content-Type: application/json" 
  -d '{
    "patientId": "pat_abc123",
    "doctorId": "usr_doctor456",
    "locationId": "loc_main",
    "procedureId": "proc_general_consult",
    "startTime": "2025-04-01T09:00:00-05:00",
    "endTime": "2025-04-01T09:30:00-05:00",
    "notes": "Consulta inicial"
  }'
Respuesta: 
{
  "id": "apt_xyz789",
  "status": "confirmed",
  "patient": {
    "id": "pat_abc123",
    "firstName": "María",
    "lastName": "García"
  },
  "startTime": "2025-04-01T09:00:00-05:00",
  "endTime": "2025-04-01T09:30:00-05:00"
}

​
¿Qué sigue?

Referencia de la API

Explore todos los endpoints disponibles.

Manejo de Errores

Aprenda a manejar los errores de la API de forma elegante.