Onglet Clés API

L'onglet Clés API n'est disponible que si votre compte dispose d'un abonnement à RICOH Predictive Insight. Pour afficher l'onglet et utiliser les touches de raccourci, vous devez disposer d'un accès Administrateur à Account Administration.

Deux liens situés en haut de l'onglet permettent d'accéder aux informations de référence concernant l'API d'exportation de données :

Premiers pas avec les clés API

Ouvre l'aide relative à l'API d'exportation de données, où vous trouverez des informations sur la marche à suivre pour commencer à utiliser les clés API, ainsi que sur les points de terminaison disponibles, les champs renvoyés par chacun d'entre eux et les limites applicables aux requêtes.

Ouvrir l'explorateur d'API

Ouvre la page de documentation interactive de l'API, sur laquelle vous pouvez consulter chaque point de terminaison, découvrir les paramètres qu'il accepte et envoyer des exemples de requêtes directement depuis votre navigateur. Vous devez disposer de la valeur d'une clé API pour envoyer une requête à partir de cette page.

Voici les actions que vous pouvez effectuer dans cet onglet :

• Consultez toutes les clés définies pour votre compte ainsi que leurs propriétés, telles que : Nom, Statut et Date d'expiration.

  La table n'affiche pas la valeur d'une clé.

• Créez une clé.

  Cliquez sur Créer une clé API. Les clés sont généralement actives dans les 30 secondes, mais des retards sont possibles.

• Surveillez les requêtes API du compte par rapport aux limites de l'abonnement.

  L'encadré situé au-dessus de la table des clés API indique le forfait d'utilisation du compte ainsi que le nombre maximal d'appels API autorisés sur une période de 30 jours. Suivez le nombre d'appels passés au cours des 30 derniers jours.

• Modifiez le nom, la description ou la date d'expiration d'une clé existante.

  Cliquez avec le bouton droit de la souris sur une ligne et sélectionnez Modifier la clé API. La modification d'une clé n'entraîne pas de changement de sa valeur ; les applications qui utilisent déjà cette clé continuent donc de fonctionner.

• Faites pivoter une clé pour remplacer sa valeur.

  Cliquez avec le bouton droit de la souris sur une ligne et sélectionnez Renouveler la clé API. Définissez une période de chevauchement afin que la valeur actuelle et la nouvelle valeur soient toutes deux valides pendant un certain nombre de jours, ce qui vous laissera le temps de mettre à jour vos applications. La clé associée à la nouvelle valeur est généralement disponible dans un délai de 30 secondes, mais des retards sont possibles.

• Supprimer une clé.

  Cliquez avec le bouton droit de la souris sur une ligne et sélectionnez Supprimer immédiatement.

  Remarque:
  • La suppression d'une clé supprime celle-ci du système en moins d'une minute, bien que des retards soient possibles. Les clés supprimées sont effacées définitivement. Si vous essayez d'envoyer une requête API à l'aide d'une clé API après l'avoir supprimée, la requête échouera.
  • La suppression d'une clé supprime toutes ses versions. Si vous effectuez une rotation de clé puis que vous la supprimez, les deux versions de la clé sont supprimées, même si la période de chevauchement est toujours en cours.

Les clés ne sont pas limitées à des imprimantes spécifiques. Toute personne disposant de la valeur d'une clé peut envoyer des requêtes au nom de votre compte. Ne communiquez les clés qu'aux personnes chargées du développement des intégrations, et remplacez-les régulièrement conformément à vos procédures de sécurité.

En cliquant sur , l'icône Outils, vous ouvrez un menu à partir duquel vous pouvez actualiser les informations du tableau et gérer ses colonnes.