Crear una clave de API

Actualizado 8 de septiembre de 2026

Una clave de API es lo que tu página de empleo, o tu ATS, presenta para llegar a tus puestos. Se crea en Orbit, se muestra una sola vez y se puede revocar en cualquier momento. Esta página es el ciclo completo: crear, guardar, rotar, revocar.

Crear la clave

1. En Orbit, abre Configuración → Claves de API.
2. Elige Nueva clave.
3. Ponle una etiqueta que diga dónde va a vivir, por ejemplo página de empleo — producción. Las claves se distinguen por la etiqueta y por sus cuatro últimos caracteres, así que una etiqueta escrita pensando en tu yo futuro vale los diez segundos.
4. Elige el permiso. Hay tres, y el correcto es el más estrecho que haga el trabajo: una clave con más alcance del que necesita es una clave que hace más daño cuando se filtra.
   • Solo lectura de empleos — tus puestos abiertos y sus detalles. Lo que necesita una página de empleo.
   • Leer y gestionar empleos — además crea, edita, publica y cierra puestos. Publicar gasta créditos, así que esto va en un sistema que tú controlas, no en la configuración de una página.
   • Screening — los endpoints de screening de candidatos, que leen datos de personas candidatas.
5. Elige Crear.

La revelación única

La clave completa se muestra una sola vez. Cópiala, ponla donde vive la configuración de tu sitio y solo entonces cierra el diálogo.

No se puede volver a mostrar, y eso no es un permiso que pudiéramos conceder después: Wipperoz guarda un hash de la clave, nunca la clave. La lista de Configuración muestra la etiqueta, los cuatro últimos caracteres, quién la creó y cuándo se usó por última vez. Nunca muestra el valor.

Guardarla

Trátala como cualquier otro secreto. La convención en esta documentación es una variable de entorno:

export ORBIT_API_KEY="…la clave que copiaste…"

Rotar sin cortes

Nada limita una cuenta a una sola clave, y solapar claves es como se rota sin que tu página de empleo se quede a oscuras. El orden importa:

1. Crea la clave de reemplazo.
2. Actualiza tu sitio para que la use y comprueba que está leyendo los puestos.
3. Revoca la clave antigua.

Revocar primero y crear después deja tu página de empleo caída durante todo el tiempo que dure el cambio.

Revocar

La revocación es inmediata y no se puede deshacer. Una petición hecha con una clave revocada se rechaza en la siguiente petición; no hay ninguna caché que esperar. Antes de revocar, mira último uso en la lista: una clave usada hace minutos es una clave de la que algo depende ahora mismo, y lo seguro es rotar como arriba en lugar de revocar sin más.

Una clave que nunca se ha usado suele significar una integración que se empezó y se abandonó, no una que esté en reposo. Es la clave más segura de revocar.

Siguiente

Haz tu primera petición con la clave en la página siguiente.