API d'exportation de données

L'API d'exportation de données est une API REST qui propose quatre points de terminaison. Vous pouvez utiliser ces points de terminaison pour télécharger des informations concernant vos imprimantes et les travaux qu'elles ont traités, ainsi que l'historique de leur état de fonctionnement et les événements ayant déclenché des messages d'avertissement ou d'erreur sur l'imprimante.

Vous pouvez utiliser l'API d'exportation des données pour extraire des données RICOH Predictive Insight et les intégrer dans des outils de veille stratégique, des entrepôts de données, des tableaux de bord et d'autres applications au sein de votre organisation.

Authentification

Vous pouvez créer et gérer des clés API sur RICOH Account Administration. Vous pouvez créer autant de clés que nécessaire : une par application qui télécharge des données ou une seule clé à utiliser à l'échelle de votre entreprise. Définissez une date d'expiration conformément à vos pratiques de sécurité et renouvelez les clés si nécessaire. Vous pouvez définir la période de chevauchement, de sorte que l'ancienne et la nouvelle clé fonctionnent toutes les deux pendant un certain nombre de jours. Si nécessaire, vous pouvez supprimer une clé pour la désactiver immédiatement.

La clé API contient également l'identité de votre locataire ; c'est pourquoi aucun paramètre de locataire ou de compte n'est requis dans aucune requête. Toute personne disposant de cette clé API peut envoyer des requêtes en votre nom ; veillez donc à protéger vos clés API comme vous le feriez pour un mot de passe.

Points de terminaison disponibles

L'API comprend les points de terminaison suivants :

/printers
Renvoie la liste des imprimantes associées à votre compte, comprenant le nom de l'imprimante, son modèle, son fabricant, son numéro de série, ses moteurs et l'état actuel de la connexion.
/jobs
Renvoie les détails relatifs aux travaux d'impression pour une ou plusieurs imprimantes, notamment la durée, le nombre d'exemplaires imprimés, le nombre de pages, le nombre d'impressions, le nombre de feuilles, la longueur du rouleau, ainsi que la consommation d'encre et de vidage par canal de couleur. Par défaut, la réponse porte sur les dernières 24 heures.
/printer-states
Renvoie l'état de fonctionnement de chaque moteur d'impression, soit sous la forme d'un historique agrégé sur une période donnée, soit sous la forme de l'état actuel uniquement. Vous pouvez récupérer les états réels de l'imprimante, tels que : Printing, Preparing, Maintenance ou Sleeping ; ces états peuvent également être regroupés en catégories : up, down, idle ou unknown.

Conseil: Le point de terminaison /printer-states fournit des informations sur l'état de chaque moteur d'impression, et non de chaque imprimante. Une imprimante dotée de plusieurs moteurs renvoie une ligne par moteur.

/printer-interventions
Renvoie les événements ayant provoqué des avertissements ou des erreurs sur une ou plusieurs imprimantes, tels qu'un bourrage papier ou une source de support vide. Chaque événement est consigné pour un seul moteur d'impression, avec l'heure à laquelle il a débuté, l'heure à laquelle il s'est terminé, sa durée, un code identifiant la condition et, le cas échéant, le nom du travail en cours d'impression. Par défaut, la réponse porte sur les dernières 24 heures. Vous pouvez demander les descriptions des événements dans n'importe laquelle des langues prises en charge.

Tester l'API

Une page de documentation interactive est à votre disposition pour vous permettre de consulter chaque point de terminaison, de découvrir les paramètres qu'il accepte et de tester des exemples de requêtes directement depuis votre navigateur. Pour ouvrir la page, rendez-vous sur :

Pour envoyer des requêtes depuis la page de documentation ou depuis vos propres applications, vous devez d'abord créer une clé API. Vous pouvez créer et gérer des clés API sur Account Administration.

Rubrique parente : Utilisation de l'API d'exportation de données