Créer une clé d'API

Mis à jour 8 septembre 2026

Une clé d’API est ce que votre page carrières, ou votre ATS, présente pour atteindre vos postes. Elle se crée dans Orbit, s’affiche une seule fois et peut être révoquée à tout moment. Cette page couvre tout le cycle de vie : créer, stocker, faire tourner, révoquer.

Créer la clé

1. Dans Orbit, ouvrez Paramètres → Clés d’API.
2. Choisissez Nouvelle clé.
3. Donnez-lui un libellé qui dit où elle vivra, par exemple page carrières — production. Les clés se distinguent par leur libellé et par leurs quatre derniers caractères : un libellé écrit pour votre futur vous vaut bien dix secondes.
4. Choisissez la portée. Il y en a trois, et la bonne est la plus étroite qui fasse le travail : une clé qui va plus loin que son travail est une clé qui fait plus de dégâts quand elle fuite.
   • Lecture des offres uniquement — vos postes ouverts et leurs détails. Ce dont une page carrières a besoin.
   • Lecture et gestion des offres — crée, modifie, publie et clôture aussi les postes. Publier consomme des crédits : cette portée appartient à un système que vous exploitez, pas à la configuration d’une page.
   • Présélection — les points d’accès de présélection, qui lisent des données de candidats.
5. Choisissez Créer.

L’affichage unique

La clé complète est affichée une seule fois. Copiez-la, placez-la là où vit la configuration de votre site, et seulement ensuite fermez la boîte de dialogue.

Elle ne peut pas être réaffichée, et ce n’est pas une permission que nous pourrions accorder plus tard : Wipperoz stocke une empreinte de la clé, jamais la clé elle-même. La liste dans Paramètres affiche le libellé, les quatre derniers caractères, qui l’a créée et sa dernière utilisation. Elle n’affiche jamais la valeur.

La stocker

Traitez-la comme n’importe quel autre secret. La convention dans cette documentation est une variable d’environnement :

export ORBIT_API_KEY="…la clé que vous avez copiée…"

Faire tourner sans interruption

Rien ne limite un compte à une seule clé, et c’est en faisant se chevaucher deux clés qu’une rotation se passe sans que votre page carrières s’éteigne. L’ordre compte :

1. Créez la clé de remplacement.
2. Mettez à jour votre site pour qu’il l’utilise, et vérifiez qu’il lit bien les postes.
3. Révoquez l’ancienne clé.

Révoquer d’abord et créer ensuite met votre page carrières hors service pendant toute la durée du remplacement.

Révoquer

La révocation est immédiate et irréversible. Une requête faite avec une clé révoquée est refusée dès la requête suivante ; il n’y a aucun cache à attendre. Avant de révoquer, regardez la dernière utilisation dans la liste : une clé utilisée il y a quelques minutes est une clé dont quelque chose dépend en ce moment, et le geste sûr est de la faire tourner comme ci-dessus plutôt que de la révoquer d’emblée.

Une clé jamais utilisée signale généralement une intégration commencée puis abandonnée, pas une intégration au repos. C’est la clé la plus sûre à révoquer.

Suite

Faites votre première requête avec la clé sur la page suivante.