Créer une clé d'API pour l'API Orbit

Cet article s’adresse aux administrateurs de compte qui connectent un site carrières ou un autre système à Orbit. Vous créez la clé dans Orbit et la collez dans ce système. La documentation développeur explique comment l’utiliser.

Ouvrir les paramètres

Sélectionnez Paramètres dans la barre latérale.

Ouvrir Clés d’API

Sous Compte, sélectionnez Clés d’API.

Commencer une nouvelle clé

Sélectionnez Nouvelle clé.

Donner un libellé à la clé

Dans Libellé, indiquez où la clé sera utilisée, par exemple l’adresse de votre page carrières. Plus tard, c’est grâce à ce libellé que vous saurez si une clé peut être révoquée sans risque.

Choisir ce qu'elle peut atteindre

Sous Ce qu’elle peut atteindre, choisissez une option :

• Lecture des offres uniquement : vos postes ouverts et leurs détails, sans aucune écriture possible.
• Lire et gérer les offres : permet aussi de créer, modifier, publier et clôturer des postes. Réservez-la à un système que vous gérez.
• Présélection : les points d’accès de présélection des candidats. Uniquement pour un serveur que vous contrôlez.

Créer la clé

Sélectionnez Créer la clé.

Copier la clé

Sélectionnez Copier cette clé et conservez-la en lieu sûr. C’est la seule fois où vous la verrez.

Confirmer que vous l'avez enregistrée

Cochez J’ai enregistré cette clé quelque part où je peux la retrouver., puis sélectionnez Terminé — fermer.

Je ne vois pas Clés d’API dans les paramètres

Seuls les administrateurs du compte peuvent créer et révoquer des clés d’API. Demandez à un administrateur de votre compte.

Le bouton de copie n'a pas fonctionné

Votre navigateur a peut-être bloqué la copie. Sélectionnez la clé à l’écran, copiez-la manuellement, puis cochez la case pour confirmer que vous l’avez enregistrée.

Si vous perdez une clé

Orbit ne stocke qu’un hachage de la clé : personne ne peut donc vous la montrer à nouveau. Remplacez-la dans cet ordre pour que votre page carrières reste en ligne :

1. Créez une clé de remplacement.
2. Placez la nouvelle clé dans votre site carrières et vérifiez que vos offres s’affichent toujours.
3. Seulement ensuite, révoquez l’ancienne clé.

Deux clés peuvent être actives en même temps, ce qui permet un remplacement sans interruption.

Révoquer une clé

Dans Clés d’API, sélectionnez Révoquer à côté de la clé, lisez ce qui cessera de fonctionner, puis sélectionnez Révoquer maintenant. La révocation prend effet dès la requête suivante et est irréversible.

Utiliser la clé

La documentation développeur couvre l’authentification, les points d’accès et des exemples. Commencez par Créer une clé d’API dans la documentation développeur Wipperoz, ou sélectionnez Lire la documentation de l’API sur l’écran des clés d’API.