La API de Viterbit permite integrar la plataforma con otros sistemas y automatizar diferentes procesos relacionados con la gestión de candidatos, ofertas y procesos de selección.
Su configuración y uso están principalmente orientados a perfiles técnicos, por lo que, para desarrollar una integración, es recomendable contar con el apoyo de tu equipo de Desarrollo o IT.
🔌 ¿Qué puedes hacer con la API?
La API permite conectar Viterbit con otros sistemas y realizar diferentes operaciones de forma programática.
Entre otras posibilidades, puedes utilizarla para:
👥 Consultar y gestionar información de candidatos.
💼 Trabajar con ofertas de empleo y procesos de selección.
📄 Exportar información de candidatos y ofertas de forma masiva.
📑 Exportar de forma masiva los CV de los candidatos.
🧩 Exportar evaluaciones realizadas a los candidatos.
📋 Exportar cuestionarios masivamente.
🔄 Integrar información entre Viterbit y otros sistemas internos de tu empresa.
⚙️ Automatizar procesos que, de realizarse manualmente desde Viterbit, requerirían mucho tiempo.
📊 Obtener información de Viterbit para utilizarla en otros sistemas o herramientas.
Estas son solo algunas de las posibilidades. La API pública de Viterbit dispone de diferentes endpoints que permiten trabajar con distintos recursos de la plataforma.
💡 Tip útil: Si necesitas realizar una operación que no encuentras disponible directamente desde la interfaz de Viterbit, consulta la documentación de la API o coméntalo con tu equipo de Desarrollo. Es posible que pueda realizarse mediante una integración.
🔑 Cómo activar y obtener la API Key
Para utilizar la API necesitarás una API Key, que funciona como credencial para autenticar las peticiones realizadas contra Viterbit.
Para acceder a esta configuración:
Ve a Ajustes.
Accede a la sección API.
Desde ahí podrás crear la API Key necesaria para realizar las peticiones.
🚨 Importante: La API Key solo puede generarla el Owner de la cuenta. Además, la clave generada se mostrará una única vez, justo después de crearla. Asegúrate de copiarla y guardarla en un lugar seguro antes de cerrar la ventana. Si no la has guardado o la has perdido, será necesario generar una nueva API Key.
⚠️ ¿No aparece la opción API?
La funcionalidad de API no está activada por defecto, incluso para los usuarios que tienen el rol de administrador. Revisa bien la sección API en los Ajustes generales, dentro del apartado Integraciones, debajo de Marketplace.
🚨 Importante: Sino aparece así como se muestra en la imagen, será necesario solicitar a tu Customer Success que active esta funcionalidad para tu cuenta.
👨💻 ¿Necesito conocimientos técnicos?
Sí. Aunque la activación de la API Key puede realizarse desde Viterbit, el desarrollo y uso de una integración requiere conocimientos técnicos.
Si quieres conectar Viterbit con otro sistema, realizar exportaciones mediante API o automatizar procesos, te recomendamos contar con tu equipo de Desarrollo o IT.
El equipo técnico podrá consultar la documentación de la API para identificar los endpoints, parámetros y métodos disponibles y desarrollar la integración que necesites.
📚 Documentación de la API
Para consultar todas las operaciones disponibles, parámetros, endpoints y ejemplos de uso, puedes acceder a la documentación oficial de nuestra API pública aquí:
La documentación técnica será la referencia principal para tu equipo de Desarrollo a la hora de implementar una integración con Viterbit.
🔎 Límites en las búsquedas por API
La tecnología de búsqueda utilizada actualmente por Viterbit establece un límite de 10.000 registros por búsqueda mediante API.
Por este motivo, no es posible recuperar más de 10.000 registros en una única búsqueda.
Si necesitas obtener un volumen superior de información, recomendamos iterar las búsquedas para recuperar progresivamente todos los registros necesarios.
⚠️ Importante: El límite de 10.000 registros se aplica a cada búsqueda. Si necesitas recuperar un volumen mayor, tu equipo de Desarrollo deberá diseñar la integración teniendo en cuenta esta limitación y dividir las consultas en diferentes búsquedas.
⚙️ Recomendaciones para trabajar con la API
Antes de desarrollar una integración, te recomendamos:
🔐 Mantener la API Key protegida y no compartirla públicamente.
👨💻 Contar con el apoyo de tu equipo de Desarrollo o IT.
📚 Revisar la documentación de la API antes de comenzar el desarrollo.
🔎 Comprobar los límites de las búsquedas cuando se trabaje con grandes volúmenes de información.
🔄 Diseñar las consultas de forma que puedan iterarse cuando sea necesario recuperar más de 10.000 registros.
🧪 Probar la integración antes de utilizarla en procesos productivos.
⚠️ Importante: La API Key debe tratarse como una credencial de acceso. Evita incluirla en código público, repositorios accesibles por terceros o compartirla con personas que no necesiten utilizarla.
🚀 ¿Qué puedo hacer si necesito una integración específica?
Si tienes un caso de uso concreto y no sabes si puede realizarse mediante API, puedes comentarlo con tu equipo de Desarrollo para que revise la documentación y determine la mejor forma de implementarlo.
Algunos ejemplos de necesidades que pueden resolverse mediante API son:
Exportar periódicamente información de candidatos.
Descargar CV de forma masiva.
Obtener evaluaciones o cuestionarios.
Sincronizar información entre Viterbit y sistemas internos.
Automatizar procesos de intercambio de información.
Crear integraciones personalizadas con otras herramientas.
La API ofrece muchas más posibilidades que las indicadas en este artículo. La documentación técnica es la mejor referencia para conocer las operaciones disponibles y determinar qué se puede implementar para cada caso de uso.