Instalacion
Instala el paquete desde npm o yarn:
# npm
npm install @vocanta/sdk
# yarn
yarn add @vocanta/sdk
# pnpm
pnpm add @vocanta/sdkInicio Rapido
Configura el cliente con tu API key y comienza a interactuar con la API:
import { VocantaClient } from '@vocanta/sdk'
const client = new VocantaClient({
apiKey: process.env.VOCANTA_API_KEY,
})
// Listar citas del dia
const appointments = await client.appointments.list({
date: '2026-03-28',
})
console.log(appointments)
// Crear una cita nueva
const newAppointment = await client.appointments.create({
patientName: 'Maria Lopez',
date: '2026-04-01',
time: '10:00',
service: 'Consulta general',
})
console.log(newAppointment.id)Soporte para TypeScript
El SDK incluye tipos completos para todas las respuestas y parametros de la API. No necesitas instalar paquetes adicionales de tipos.
import type { Appointment, Patient } from '@vocanta/sdk'
// Autocompletado completo en tu IDE
const appointment: Appointment = await client.appointments.get('apt_123')
const patient: Patient = await client.patients.get(appointment.patientId)Metodos Principales
| Modulo | Metodos |
|---|---|
| appointments | list, get, create, update, cancel |
| patients | list, get, create, update, search |
| agents | list, get, configure, getStatus |
| webhooks | list, create, delete, verify |
Gestion de API Keys
Tu API key se administra desde el panel de Vocanta en Configuracion > API Keys. Recomendaciones:
- Nunca incluyas la API key directamente en el codigo fuente
- Usa variables de entorno (
VOCANTA_API_KEY) - Rota las keys periodicamente desde el panel
- Asigna permisos minimos necesarios a cada key
Manejo de Errores
import { VocantaError } from '@vocanta/sdk'
try {
await client.appointments.create({ ... })
} catch (error) {
if (error instanceof VocantaError) {
console.error(error.code, error.message)
// Codigos: 'UNAUTHORIZED', 'NOT_FOUND', 'VALIDATION_ERROR', etc.
}
}