Crear una clave de API
Actualizado
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
- En Orbit, abre Configuración → Claves de API.
- Elige Nueva clave.
- 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. - Elige el permiso. Hay cuatro, 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 pone un anuncio delante del público, así que esto va en un sistema que tú controlas, no en la configuración de una página. Pese al nombre, no gestiona avisos en el sentido de Orbit: eso se activa aviso por aviso en Orbit.
- Screening — invita a tus personas candidatas a evaluaciones con IA en avisos gestionados, y llega a datos de personas candidatas. Emitirla es el consentimiento de la cuenta a las evaluaciones adicionales más allá de las incluidas en un aviso, hasta el límite mensual de Orbit → Facturación, así que va en un servidor que tú controlas. Consulta Evaluar a una persona candidata.
- Recibir candidaturas — envía a Wipperoz las candidaturas y los candidatos que recogieron tus propias páginas, y lee el estado de cada candidatura. Lleva el consentimiento de las personas candidatas, así que un Administrador solo puede crearla después de aceptar la Adenda de tratamiento de datos de la API, más abajo. Consulta Recibir candidaturas desde tu propia página de empleo.
- Elige Crear.
La Adenda de tratamiento de datos de la API
En la página de postulación alojada, Wipperoz muestra a la persona candidata su texto de consentimiento y registra la aceptación. Cuando la postulación ocurre en tu página, el texto lo muestras tú y la aceptación la registras tú, y la Adenda de tratamiento de datos de la API es donde tu cuenta asume eso: mostrar el texto sin modificar, enviar un recibo veraz, atestar una base legal para cada persona que envías y mantener la clave en tus servidores.
La acepta un Administrador, una sola vez, en Orbit → Configuración → Claves de API; Wipperoz registra la versión, el Administrador y la hora en el historial de consentimientos de la cuenta, junto al Acuerdo de Tratamiento. Hasta entonces, Orbit se niega a crear una clave con Recibir candidaturas y dice por qué. Una nueva versión de la adenda pide a un Administrador que la acepte antes de crear la siguiente clave Recibir candidaturas; las claves existentes siguen funcionando.
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:
- Crea la clave de reemplazo.
- Actualiza tu sitio para que la use y comprueba que está leyendo los puestos.
- 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.
