Clés API

Un Clé API est une information d'identification qui autorise une application à envoyer des requêtes à l'API RICOH TotalFlow Cloud au nom de votre compte. Vous définissez les clés API dans RICOH Account Administration.

Les applications qui utilisent une API au lieu de l'interface utilisateur ne peuvent pas se connecter en tant qu'utilisateur. Au lieu de cela, chaque requête contient la valeur d'une clé API, qui identifie le compte auquel appartient la requête. La clé contenant l'identifiant de votre compte, il n'est pas nécessaire d'indiquer de paramètre de compte ou de locataire dans les requêtes.

Vous pouvez définir jusqu'à dix clés pour votre compte. De nombreuses organisations créent une clé distincte pour chaque application qui récupère des données, de sorte qu'une clé puisse être remplacée ou supprimée sans perturber le fonctionnement des autres applications. Chaque clé possède un nom, une description et une date d'expiration.

La valeur d'une clé n'est affichée qu'une seule fois, au moment où vous créez ou renouvelez la clé. Account Administration ne stocke pas cette valeur sous une forme permettant de l'afficher à nouveau ; vous devez donc la copier et la conserver en lieu sûr dès qu'elle s'affiche. En cas de perte d'une valeur, vous faites pivoter la clé pour en générer une nouvelle. Toute personne en possession de cette valeur peut envoyer des requêtes en se faisant passer pour votre compte ; veillez donc à protéger vos clés comme vous protégez un mot de passe. Les clés ne sont pas limitées à des imprimantes spécifiques.

La gestion des clés s'effectue dans l'onglet Clés API. Vous pouvez modifier le nom, la description ou la date d'expiration d'une clé ; effectuer une rotation de clé afin de remplacer sa valeur tout en conservant son identité ; ou supprimer une clé pour révoquer immédiatement l'accès.

Dans RICOH TotalFlow Cloud, les clés API sont utilisées avec l'API d'exportation de données, qui récupère les informations relatives aux imprimantes, aux travaux et à l'état des imprimantes collectées par RICOH Predictive Insight. Le nombre de requêtes API que votre compte peut effectuer, toutes clés API confondues, est déterminé par votre abonnement. Chaque abonnement fixe une limite maximale pour le nombre de requêtes API autorisées sur une période glissante de 30 jours. Si vous dépassez le nombre d'appels autorisé par votre abonnement, aucune requête ne sera acceptée tant que le nombre total de requêtes des 30 derniers jours n'aura pas repassé sous la limite fixée par votre abonnement. Pour connaître le nombre d'appels inclus dans votre abonnement et le nombre d'appels que vous avez utilisés au cours des 30 derniers jours, consultez la page Clés API. Si vous constatez que vous avez besoin d'une capacité supplémentaire pour les requêtes API, veuillez vous adresser à votre représentant Ricoh pour passer à un abonnement supérieur.