Création et gestion des clés API
Une clé API autorise les requêtes adressées à l'API d'exportation de données. Vous
créez et gérez vos clés API sur Account Administration, et vous indiquez cette clé lorsque vous envoyez des requêtes depuis la page « Explorateur
d'API » ou depuis vos propres applications.
Chaque requête adressée à l'API d'exportation de données doit comporter une clé API
valide dans l'en-tête de requête x-api-key. La clé authentifie la requête adressée à votre compte (client).
Pour créer des clés API, vous devez disposer d'un accès Administrateur à Account Administration.
Suivez les procédures décrites dans cette rubrique pour :
- Créez une nouvelle clé API.
- Modifiez le nom, la date d'expiration ou la description d'une clé existante.
- Faites pivoter une clé pour remplacer sa valeur secrète sans modifier l'identité de la clé.
- Supprimer une clé du système.
Remarque: Lorsque vous créez ou renouvelez une clé API, il s'écoule un court laps de temps avant
que la clé ne soit enregistrée et prête à être utilisée. En règle générale, ce délai
est inférieur à une minute.
- Pour créer une nouvelle clé API :
- Dans le volet gauche de Account Administration, cliquez sur Clés API.
- Cliquez sur Créer une clé API.
- Veuillez saisir un nom et une description pour cette clé.
- Pour Date d'expiration, choisissez une date située dans les 367 prochains jours.
- Pour Licences, choisissez Plan d'utilisation d'exportation de données RPI pour les clés API.
- Cliquez sur Suivant.La clé est générée et enregistrée.
- Cliquez sur Copier pour copier la clé générée dans votre presse-papiers. Conservez-le en lieu sûr. Important: La valeur complète de la clé n'est affichée que lors de la création de celle-ci. Vous ne pouvez plus y accéder. Si vous perdez cette valeur, vous devez changer de clé pour en générer une nouvelle.
- Cliquez sur J'ai sauvegardé ma clé pour fermer la boîte de dialogue.
- Pour modifier une clé API existante :
- Dans le volet gauche de Account Administration, cliquez sur Clés API.
- Repérez la clé que vous souhaitez modifier. Cliquez avec le bouton droit de la souris sur la ligne correspondant à la clé, puis sélectionnez Modifier la clé API.
- Modifiez le nom, la date d'expiration ou la description si nécessaire.La modification d'une clé n'entraîne pas de changement de sa valeur. Les applications qui utilisent déjà cette clé continuent de fonctionner sans modification.
- Cliquez sur OK.
- Pour renouveler une clé API :
- Dans le volet gauche de Account Administration, cliquez sur Clés API.
- Repérez la clé que vous souhaitez faire pivoter. Cliquez avec le bouton droit de la souris sur la ligne correspondant à la clé, puis sélectionnez Renouveler la clé API.
- Définissez Période de chevauchement en jours sur le nombre de jours pendant lesquels vous souhaitez que la clé existante et la version alternée restent actives simultanément.
- Définissez une nouvelle valeur Date d'expiration pour la clé.
- Cliquez sur OK.
- Cliquez sur Copier pour copier la clé générée dans votre presse-papiers. Conservez-le en lieu sûr. Important: La valeur complète de la clé n'est affichée que lors de la création de celle-ci. Vous ne pouvez plus y accéder. Si vous perdez cette valeur, vous devez changer de clé pour en générer une nouvelle.
- Mettez à jour toutes les applications, tous les scripts ou toutes les sessions de documentation interactive enregistrées qui utilisent cette clé avant l'expiration de la période de chevauchement.
- Pour supprimer une clé du système :
- Dans le volet gauche de Account Administration, cliquez sur Clés API.
- Repérez la clé que vous souhaitez faire pivoter. Cliquez avec le bouton droit de la souris sur la ligne correspondant à la clé, puis sélectionnez Supprimer immédiatement.
- Dans la boîte de dialogue, sélectionnez Oui, supprimer la clé.Cette étape est obligatoire, car la suppression est définitive. Une fois la clé supprimée, vous ne pourrez plus la récupérer.
- Cliquez sur OK.
Vous pouvez utiliser la clé API nouvelle ou mise à jour sur la page de documentation interactive pour tester l'API d'exportation de données, ainsi que dans toute application qui envoie des requêtes à cette API.