¿Cómo uso la API abierta (OpenAPI)?

Nuestro complemento API Abierta conecta Vacation Tracker con tus propias herramientas. Crea una clave API, elige qué puede hacer y úsala para leer y modificar tus datos o recibir avisos cuando algo cambie.

Cómo crear una clave API

1. Inicia sesión en tu cuenta de Vacation Tracker en app.vacationtracker.io/signin.
2. Abre Complementos en el menú de la izquierda.
3. En la pestaña Mis Complementos, busca API Abierta y haz clic en Ver. Si no aparece, búscalo en la pestaña Descubrir Más Complementos y actívalo primero.
4. En la sección Claves API, haz clic en Crear clave API.
5. Escribe un Nombre de la clave. Solo las personas de tu empresa ven este nombre.
6. Si quieres, escribe un Nombre de la integración. Aparece en Vacation Tracker junto a cada cambio que haga la clave, por ejemplo «Aprobado por Jane (a través de Payroll sync)». Déjalo vacío para mostrar solo el nombre de la persona.
7. En Permisos, elige una plantilla y ajústala si es necesario (ver más abajo).
8. En Caducidad, elige cuándo caduca la clave: en 30 días, en 90 días, en 1 año (recomendado) o nunca.
9. Revisa el Resumen y haz clic en Crear clave API.
10. Copia la clave y guárdala en un lugar seguro. La clave completa solo se muestra una vez, al crearla.

Cómo elegir los permisos

Empieza con una plantilla y luego ajústala:

• Solo lectura: ver los datos sin cambiar nada. Ideal para informes y paneles.
• Gestión de ausencias: solicitar, añadir y aprobar ausencias. Leer usuarios y tipos de ausencia.
• Configuración del espacio de trabajo: configurar ubicaciones, departamentos, tipos de ausencia, políticas, festivos y usuarios.
• Personalizado: elegir cada permiso por tu cuenta.

Cada permiso se puede configurar como Sin acceso, Lectura o Lectura y escritura. Aprobar y rechazar solicitudes, ver los nombres de los tipos de ausencia ocultos y actuar en nombre de otros usuarios son casillas independientes, así que actívalas solo si tu herramienta las necesita. Una clave solo puede hacer lo que tú tienes permitido hacer en Vacation Tracker.

Cómo gestionar tus claves

La tabla Claves API muestra todas las claves de tu espacio de trabajo con su propietario, sus permisos, su último uso, su fecha de caducidad y su estado. Haz clic en una clave para abrir sus detalles, donde puedes:

• Ver el uso de este mes y editar el nombre y los permisos de la clave.
• Consultar la Actividad reciente, que muestra cada solicitud que ha modificado datos.
• Hacer clic en Rotar clave para obtener una clave nueva con el mismo nombre y los mismos permisos. Elige si la clave anterior sigue funcionando durante 24 horas (recomendado), durante 7 días o deja de funcionar al instante.
• Hacer clic en Revocar para desactivar la clave de forma definitiva.

Te enviamos un correo electrónico 14 días antes de que caduque una clave.

Tu primera solicitud

La URL base es https://api.vacationtracker.io/v2. Envía tu clave como token bearer en el encabezado Authorization:

Una llamada correcta devuelve los datos en data. Las listas con más páginas incluyen también un nextToken, que debes enviar de vuelta para obtener la página siguiente.

Si algo sale mal, la respuesta incluye un error con un código, una descripción y una solución. Una clave ausente o desconocida devuelve el código 401. Una clave sin el permiso que necesita una solicitud devuelve el código 403 con INSUFFICIENT_SCOPE.

Cómo añadir un webhook

1. En la página del complemento API Abierta, ve a Webhooks y haz clic en Gestionar webhooks.
2. Haz clic en Añadir webhook.
3. Introduce la URL del endpoint que recibirá los eventos. Debe usar HTTPS.
4. En Eventos, elige Decisiones sobre ausencias, Toda la actividad de ausencias, Mantener una copia completa sincronizada o Personalizado para elegir los eventos por tu cuenta.
5. Haz clic en Añadir webhook.

Solo recibes eventos de los datos que tienes permitido ver.

Cuotas y límites de uso

Los límites se aplican por clave API:

• Hasta 30 000 solicitudes al mes.
• 10 solicitudes por segundo, con picos de hasta 50 solicitudes.

Si tu integración necesita más, escribe a developers@vacationtracker.io indicando el nombre de tu empresa, la integración y el tráfico que esperas.

Preguntas frecuentes